diff --git a/README.md b/README.md index 3745fe25..223d773a 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,20 @@ Will produce a file called `API.md` with the api reference for this module. As a library: ```ts -import { Documentation } from 'jsii-docgen'; +import { Documentation, Language } from 'jsii-docgen'; -const docs = await Documentation.forLocalPackage('.', { language: 'ts' }); -const markdown = docs.render().render(); // returns a markdown string +const docs = await Documentation.forProject('.'); +const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }).render(); // returns a markdown string + +const json = await docs.toJson({ language: Language.TYPESCRIPT }).render(); // returns a JSON object ``` -Note that you can pass in either `ts` or `python` as the language, as opposed to the CLI, which only produces a TypeScript reference. +Curreently jsii-docgen supports generating documentation in the following languages: + +- TypeScript (`typescript`) +- Python (`python`) +- Java (`java`) +- C# (`csharp` or `dotnet`) ## Contributions diff --git a/src/cli.ts b/src/cli.ts index 11c0288f..12c9eed2 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -6,16 +6,20 @@ import { Documentation } from './index'; export async function main() { const args = yargs .usage('Usage: $0') - .option('output', { type: 'string', alias: 'o', required: false, desc: 'Output filename (defaults to API.md)' }) + .option('output', { type: 'string', alias: 'o', required: false, desc: 'Output filename (defaults to API.md if format is markdown, and API.json if format is JSON)' }) + .option('format', { alias: 'f', default: 'md', choices: ['md', 'json'], desc: 'Output format, markdown or json' }) .option('language', { alias: 'l', default: 'typescript', choices: Language.values().map(x => x.toString()), desc: 'Output language' }) .example('$0', 'Generate documentation for the current module as a single file (auto-resolves node depedencies)') .argv; const language = Language.fromString(args.language); const docs = await Documentation.forProject(process.cwd()); - const output = args.output ?? 'API.md'; - const markdown = await docs.render({ readme: false, language }); - fs.writeFileSync(output, markdown.render()); + const options = { readme: false, language }; + const fileSuffix = args.format === 'md' ? 'md' : 'json'; + const output = args.output ?? `API.${fileSuffix}`; + + const content = await (args.format === 'md' ? docs.toMarkdown(options) : docs.toJson(options)); + fs.writeFileSync(output, content.render()); } main().catch(e => { diff --git a/src/docgen/render/json.ts b/src/docgen/render/json.ts new file mode 100644 index 00000000..47ef889a --- /dev/null +++ b/src/docgen/render/json.ts @@ -0,0 +1,10 @@ +/** + * Type-safe Json renderer. + */ +export class Json { + constructor(public readonly content: T) {}; + + public render(replacer?: any, space?: string | number): string { + return JSON.stringify(this.content, replacer, space); + } +} diff --git a/src/docgen/render/markdown.ts b/src/docgen/render/markdown-doc.ts similarity index 74% rename from src/docgen/render/markdown.ts rename to src/docgen/render/markdown-doc.ts index 98a8cf6d..fca408b0 100644 --- a/src/docgen/render/markdown.ts +++ b/src/docgen/render/markdown-doc.ts @@ -1,15 +1,4 @@ -import * as reflect from 'jsii-reflect'; - -const sanitize = (input: string): string => { - return input - .toLowerCase() - .replace(/[^a-zA-Z0-9 ]/g, '') - .replace(/ /g, '-'); -}; - -export const anchorForId = (id: string): string => { - return sanitize(id); -}; +import { DocsSchema } from '../schema'; /** * Options for defining a markdown header. @@ -64,11 +53,11 @@ export interface MarkdownOptions { /** * Markdown element. */ -export class Markdown { +export class MarkdownDocument { /** * An empty markdown element. */ - public static readonly EMPTY = new Markdown(); + public static readonly EMPTY = new MarkdownDocument(); /** * Sanitize markdown reserved characters from external input. @@ -90,7 +79,8 @@ export class Markdown { } public static pre(text: string): string { - return `\`${text}\``; + // using instead of backticks since this allows links + return `${text}`; } public static italic(text: string) { @@ -98,7 +88,7 @@ export class Markdown { } private readonly _lines = new Array(); - private readonly _sections = new Array(); + private readonly _sections = new Array(); private readonly id?: string; private readonly header?: string; @@ -109,25 +99,22 @@ export class Markdown { } /** - * Render a `jsii-reflect.Docs` element into the markdown. + * Render a docs element into the markdown. */ - public docs(docs: reflect.Docs) { + public docs(docs: DocsSchema) { if (docs.summary) { - this.lines(Markdown.sanitize(docs.summary)); + this.lines(MarkdownDocument.sanitize(docs.summary)); this.lines(''); } if (docs.remarks) { - this.lines(Markdown.sanitize(docs.remarks)); + this.lines(MarkdownDocument.sanitize(docs.remarks)); this.lines(''); } - if (docs.docs.see) { - this.quote(docs.docs.see); - } - - const customLink = docs.customTag('link'); - if (customLink) { - this.quote(`[${customLink}](${customLink})`); + if (docs.links) { + for (const link of docs.links) { + this.quote(`[${link}](${link})`); + } } } @@ -166,7 +153,7 @@ export class Markdown { this.lines(''); } - public section(section: Markdown) { + public section(section: MarkdownDocument) { this._sections.push(section); } @@ -180,20 +167,16 @@ export class Markdown { const content: string[] = []; if (this.header) { - const anchor = anchorForId(this.id ?? ''); const heading = `${'#'.repeat(headerSize)} ${this.header}`; - // This is nasty, i'm aware. - // Its just an escape hatch so that produce working links by default, but also support producing the links that construct-hub currently relies on. - // This will be gone soon. - // Note though that cross links (i.e links dependencies will not work yet regardless) + // temporary hack to avoid breaking Construct Hub const headerSpan = !!process.env.HEADER_SPAN; if (headerSpan) { content.push( - `${heading} `, + `${heading} `, ); } else { - content.push(`${heading} `); + content.push(`${heading} `); } content.push(''); } diff --git a/src/docgen/render/markdown-render.ts b/src/docgen/render/markdown-render.ts new file mode 100644 index 00000000..a9af0403 --- /dev/null +++ b/src/docgen/render/markdown-render.ts @@ -0,0 +1,763 @@ +import { ApiReferenceSchema, AssemblyMetadataSchema, ClassSchema, ConstructSchema, EnumMemberSchema, EnumSchema, InitializerSchema, InterfaceSchema, JsiiEntity, MethodSchema, ParameterSchema, PropertySchema, Schema, StructSchema, TypeSchema } from '../schema'; +import { Language } from '../transpile/transpile'; +import { MarkdownDocument } from './markdown-doc'; + +export interface MarkdownFormattingOptions { + /** + * How jsii entity IDs should be formatted into anchors. This should be + * customized in conjunction with `linkFormatter`. + * + * @param type - the entity we are creating an anchor for + * + * @experimental + * @default - use the full id + */ + readonly anchorFormatter?: (type: JsiiEntity) => string; + + /** + * How should links to entities be rendered. For example, if a class or a + * property is referenced within a description or table. + * + * The `metadata` parameter can be optionally used to customize links based + * on whether or not the type belongs to the package / submodule that is + * being generated. + * + * @param type - the entity we are creating a link for + * @param metadata - information about the module being docgen-ed + * + * @experimental + * @default - '{type.displayName}' if the type + * belongs to this package, '{type.fqn}' otherwise + */ + readonly linkFormatter?: (type: JsiiEntity, metadata: AssemblyMetadataSchema) => string; + + /** + * How type signatures should be formatted, including those made of nested + * types (like `Map`). + * + * The `metadata` and `linkFormatter` parameters are provided so that links + * can be included in the formatted types if desired. + * + * @param type - the type being formatted + * @param metadata - information about the module being docgen-ed + * @param linkFormatter - the type link formatter + * + * @experimental + * @default - HTML code block with type references linked + * according to `linkFormatter` + */ + readonly typeFormatter?: ( + type: TypeSchema, + metadata: AssemblyMetadataSchema, + linkFormatter: (type: JsiiEntity, metadata: AssemblyMetadataSchema) => string + ) => string; +} + +export interface MarkdownRendererOptions extends MarkdownFormattingOptions, AssemblyMetadataSchema { + /** + * Language the documentation is rendered for. + */ + readonly language: Language; +} + +/** + * Generates `MarkdownDocument` instances from `API.json` or its parts. + * + * This class can be used in two ways: + * + * 1. Instantiate it via the constructor with `options`, which requires + * passing in some global context about the module and language you are + * generated for. (This context can be found in the top-level `metadata` + * field of API.json.) Then, call a `visitXxx` method to generate a + * `MarkdownDocument` for the appropriate part of the schema. + * + * 2. Generate a `MarkdownDocument` from the complete `API.json` using the + * `fromSchema` static method (no instantiation needed). Global context is + * automatically inferred from the API.json. + * + * Both choices allow customizing the output via `MarkdownFormattingOptions`. + */ +export class MarkdownRenderer { + public static fromSchema(schema: Schema, options: MarkdownFormattingOptions): MarkdownDocument { + const documentation = new MarkdownDocument(); + + if (schema.version !== '0.1') { + throw new Error(`Unexpected schema version: ${schema.version}`); + } + + if (schema.readme) { + const md = new MarkdownDocument(); + md.lines(schema.readme); + documentation.section(md); + } + + if (schema.apiReference) { + const renderer = new MarkdownRenderer({ + anchorFormatter: options.anchorFormatter, + linkFormatter: options.linkFormatter, + typeFormatter: options.typeFormatter, + language: Language.fromString(schema.language), + ...schema.metadata, + }); + documentation.section(renderer.visitApiReference(schema.apiReference)); + } + + return documentation; + } + + private readonly anchorFormatter: NonNullable; + private readonly linkFormatter: NonNullable; + private readonly typeFormatter: NonNullable; + private readonly metadata: AssemblyMetadataSchema; + private readonly language: Language; + + constructor(options: MarkdownRendererOptions) { + this.anchorFormatter = options.anchorFormatter ?? defaultAnchorFormatter; + this.linkFormatter = options.linkFormatter ?? defaultLinkFormatter; + this.typeFormatter = options.typeFormatter ?? defaultTypeFormatter; + this.language = options.language; + this.metadata = { + packageName: options.packageName, + packageVersion: options.packageVersion, + submodule: options.submodule, + }; + } + + public visitApiReference( + apiRef: ApiReferenceSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ header: { title: 'API Reference' }, id: 'api-reference' }); + md.section(this.visitConstructs(apiRef.constructs)); + md.section(this.visitStructs(apiRef.structs)); + md.section(this.visitClasses(apiRef.classes)); + md.section(this.visitInterfaces(apiRef.interfaces)); + md.section(this.visitEnums(apiRef.enums)); + return md; + } + + public visitConstructs( + constructs: ConstructSchema[], + ): MarkdownDocument { + if (constructs.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Constructs' } }); + for (const construct of constructs) { + md.section(this.visitConstruct(construct)); + } + return md; + } + + public visitStructs( + structs: StructSchema[], + ): MarkdownDocument { + if (structs.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Structs' } }); + for (const struct of structs) { + md.section(this.visitStruct(struct)); + } + return md; + } + + public visitClasses( + classes: ClassSchema[], + ): MarkdownDocument { + if (classes.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Classes' } }); + for (const klass of classes) { + md.section(this.visitClass(klass)); + } + return md; + } + + public visitInterfaces( + ifaces: InterfaceSchema[], + ): MarkdownDocument { + if (ifaces.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Protocols' } }); + for (const iface of ifaces) { + md.section(this.visitInterface(iface)); + } + return md; + } + + public visitEnums( + enums: EnumSchema[], + ): MarkdownDocument { + if (enums.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Enums' } }); + for (const enu of enums) { + md.section(this.visitEnum(enu)); + } + return md; + } + + public visitConstruct( + construct: ConstructSchema, + ): MarkdownDocument { + return this.visitClass(construct); + } + + public visitStruct( + struct: StructSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: struct.id, + displayName: struct.displayName, + fqn: struct.fqn, + ...this.metadata, + }), + header: { title: struct.displayName }, + }); + + if (struct.docs) { + md.docs(struct.docs); + } + + const initializer = new MarkdownDocument({ + id: `${struct.id}.Initializer`, + header: { title: 'Initializer' }, + }); + + if (struct.usage) { + initializer.code(this.language.toString(), struct.usage); + } + + md.section(initializer); + md.section(this.visitProperties(struct.properties)); + return md; + } + + public visitClass( + klass: ClassSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: klass.id, + displayName: klass.displayName, + fqn: klass.fqn, + ...this.metadata, + }), + header: { title: klass.displayName }, + }); + + if (klass.interfaces.length > 0) { + const ifaces = []; + for (const iface of klass.interfaces) { + ifaces.push(this.linkFormatter(iface, this.metadata)); + } + md.bullet(`${MarkdownDocument.italic('Implements:')} ${ifaces.join(', ')}`); + md.lines(''); + } + + if (klass.docs) { + md.docs(klass.docs); + } + + if (klass.initializer) { + md.section(this.visitInitializer(klass.initializer)); + } + + md.section(this.visitInstanceMethods(klass.instanceMethods)); + md.section(this.visitStaticFunctions(klass.staticMethods)); + md.section(this.visitProperties(klass.properties)); + md.section(this.visitConstants(klass.constants)); + return md; + } + + public visitInterface( + iface: InterfaceSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: iface.id, + displayName: iface.displayName, + fqn: iface.fqn, + ...this.metadata, + }), + header: { title: iface.displayName }, + }); + + if (iface.interfaces.length > 0) { + const bases = []; + for (const base of iface.interfaces) { + bases.push(this.linkFormatter(base, this.metadata)); + } + md.bullet(`${MarkdownDocument.italic('Extends:')} ${bases.join(', ')}`); + md.lines(''); + } + + if (iface.implementations.length > 0) { + const impls = []; + for (const impl of iface.implementations) { + impls.push(this.linkFormatter(impl, this.metadata)); + } + md.bullet(`${MarkdownDocument.italic('Implemented By:')} ${impls.join(', ')}`); + md.lines(''); + } + + if (iface.docs) { + md.docs(iface.docs); + } + + md.section(this.visitInstanceMethods(iface.instanceMethods)); + md.section(this.visitProperties(iface.properties)); + return md; + } + + public visitEnum( + enu: EnumSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: enu.id, + displayName: enu.displayName, + fqn: enu.fqn, + ...this.metadata, + }), + header: { title: enu.displayName }, + }); + + md.table(this.createTable(enu.members)); + md.split(); + + if (enu.docs) { + md.docs(enu.docs); + } + + for (const em of enu.members) { + md.section(this.visitEnumMember(em)); + } + + return md; + } + + public visitProperties( + properties: PropertySchema[], + ): MarkdownDocument { + if (properties.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Properties' } }); + + md.table(this.createTableWithTypes(properties)); + md.split(); + + for (const prop of properties) { + md.section(this.visitProperty(prop)); + } + + return md; + } + + public visitInitializer( + init: InitializerSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: init.id, + displayName: init.displayName, + fqn: init.fqn, + ...this.metadata, + }), + header: { + title: 'Initializers', + }, + }); + + if (init.usage) { + md.code(this.language.toString(), init.usage); + } + + md.table(this.createTableWithTypes(init.parameters)); + md.split(); + + for (const param of init.parameters) { + md.section(this.visitParameter(param)); + } + + return md; + } + + public visitInstanceMethods( + methods: MethodSchema[], + ): MarkdownDocument { + if (methods.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Methods' } }); + + md.table(this.createTable(methods)); + md.split(); + + for (const method of methods) { + md.section(this.visitInstanceMethod(method)); + } + return md; + } + + public visitStaticFunctions( + methods: MethodSchema[], + ) { + if (methods.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Static Functions' } }); + + md.table(this.createTable(methods)); + md.split(); + + for (const method of methods) { + md.section(this.visitStaticFunction(method)); + } + return md; + } + + public visitConstants( + constants: PropertySchema[], + ): MarkdownDocument { + if (constants.length === 0) { + return MarkdownDocument.EMPTY; + } + + const md = new MarkdownDocument({ header: { title: 'Constants' } }); + + md.table(this.createTableWithTypes(constants)); + md.split(); + + for (const con of constants) { + md.section(this.visitConstant(con)); + } + + return md; + } + + public visitEnumMember( + em: EnumMemberSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: em.id, + displayName: em.displayName, + fqn: em.fqn, + ...this.metadata, + }), + header: { + title: em.displayName, + pre: true, + strike: em.docs.deprecated, + }, + }); + + if (em.docs.deprecated) { + md.bullet( + `${MarkdownDocument.italic('Deprecated:')} ${em.docs.deprecationReason}`, + ); + md.lines(''); + } + + if (em.docs) { + md.docs(em.docs); + } + + md.split(); + md.lines(''); + + return md; + } + + public visitProperty( + prop: PropertySchema, + ): MarkdownDocument { + const optionality = prop.optional + ? 'Optional' + : 'Required'; + + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: prop.id, + displayName: prop.displayName, + fqn: prop.fqn, + ...this.metadata, + }), + header: { + title: prop.displayName, + sup: optionality, + pre: true, + strike: prop.docs.deprecated, + }, + }); + + if (prop.docs.deprecated) { + md.bullet( + `${MarkdownDocument.italic('Deprecated:')} ${prop.docs.deprecationReason}`, + ); + md.lines(''); + } + + if (prop.usage) { + md.code(this.language.toString(), prop.usage); + } + + const metadata: Record = { + Type: this.typeFormatter(prop.type, this.metadata, this.linkFormatter), + }; + + if (prop.default) { + metadata.Default = MarkdownDocument.sanitize(prop.default); + } + + for (const [key, value] of Object.entries(metadata)) { + md.bullet(`${MarkdownDocument.italic(`${key}:`)} ${value}`); + } + md.lines(''); + + if (prop.docs) { + md.docs(prop.docs); + } + + md.split(); + + return md; + } + + public visitParameter( + parameter: ParameterSchema, + ): MarkdownDocument { + const optionality = parameter.optional ? 'Optional' : 'Required'; + + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: parameter.id, + displayName: parameter.displayName, + fqn: parameter.fqn, + ...this.metadata, + }), + header: { + title: parameter.displayName, + sup: optionality, + pre: true, + strike: parameter.docs.deprecated, + }, + }); + + if (parameter.docs.deprecated) { + md.bullet( + `${MarkdownDocument.italic('Deprecated:')} ${parameter.docs.deprecationReason}`, + ); + md.lines(''); + } + + + const metadata: any = { + Type: this.typeFormatter(parameter.type, this.metadata, this.linkFormatter), + }; + + if (parameter.default) { + metadata.Default = MarkdownDocument.sanitize(parameter.default); + } + + for (const [key, value] of Object.entries(metadata)) { + md.bullet(`${MarkdownDocument.italic(`${key}:`)} ${value}`); + } + md.lines(''); + + if (parameter.docs) { + md.docs(parameter.docs); + } + + md.split(); + + return md; + } + + public visitInstanceMethod( + method: MethodSchema, + ): MarkdownDocument { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: method.id, + displayName: method.displayName, + fqn: method.fqn, + ...this.metadata, + }), + header: { + title: method.displayName, + pre: true, + strike: method.docs.deprecated, + }, + }); + + if (method.usage) { + md.code(this.language.toString(), method.usage); + } + + for (const param of method.parameters) { + md.section(this.visitParameter(param)); + } + + return md; + } + + public visitStaticFunction( + method: MethodSchema, + ) { + const md = new MarkdownDocument({ + id: this.anchorFormatter({ + id: method.id, + displayName: method.displayName, + fqn: method.fqn, + ...this.metadata, + }), + header: { + title: method.displayName, + pre: true, + strike: method.docs.deprecated, + }, + }); + + if (method.usage) { + md.code(this.language.toString(), method.usage); + } + + for (const param of method.parameters) { + md.section(this.visitParameter(param)); + } + + return md; + } + + public visitConstant( + constant: PropertySchema, + ): MarkdownDocument { + return this.visitProperty(constant); + } + + private createTable(items: SimpleTableItem[]): string[][] { + const tableRows: string[][] = []; + tableRows.push(['Name', 'Description'].map(MarkdownDocument.bold)); + + for (const item of items) { + const link = MarkdownDocument.pre(this.linkFormatter({ + fqn: item.fqn, + displayName: item.displayName, + id: item.id, + ...this.metadata, + }, this.metadata)); + const description = item.docs?.summary && item.docs?.summary.length > 0 + ? item.docs?.summary + : MarkdownDocument.italic('No description.'); + tableRows.push([link, description]); + } + + return tableRows; + } + + private createTableWithTypes(items: TypeTableItem[]): string[][] { + const tableRows: string[][] = []; + tableRows.push(['Name', 'Type', 'Description'].map(MarkdownDocument.bold)); + + for (const item of items) { + const link = MarkdownDocument.pre(this.linkFormatter({ + fqn: item.fqn, + displayName: item.displayName, + id: item.id, + ...this.metadata, + }, this.metadata)); + const type = MarkdownDocument.pre(this.typeFormatter(item.type, this.metadata, this.linkFormatter)); + const description = item.docs?.summary && item.docs?.summary.length > 0 + ? item.docs?.summary + : MarkdownDocument.italic('No description.'); + tableRows.push([link, type, description]); + } + + return tableRows; + } +} + +interface SimpleTableItem { + readonly fqn: string; + readonly displayName: string; + readonly id: string; + readonly docs?: { summary?: string }; +} + +interface TypeTableItem extends SimpleTableItem { + readonly type: TypeSchema; +} + +function sanitize(str: string) { + return str.replace(/ /g, '-'); +} + +export const defaultAnchorFormatter = (type: JsiiEntity) => { + // HTML5 allows any character in IDs /except/ whitespace + return sanitize(type.id); +}; + +export const defaultLinkFormatter = (type: JsiiEntity, metadata: AssemblyMetadataSchema) => { + if (type.packageName === metadata.packageName && type.submodule === metadata.submodule) { + return `${type.displayName}`; + } else { + // do not display a link if the type isn't in this document + return type.fqn; + } +}; + +function isJsiiType(value: any): value is JsiiEntity { + return ( + value !== null + && typeof value === 'object' + && value?.fqn + && value?.id + && value?.displayName + ); +} + +export const defaultTypeFormatter = ( + type: TypeSchema, + metadata: AssemblyMetadataSchema, + linkFormatter: (type: JsiiEntity, metadata: AssemblyMetadataSchema) => string, +): string => { + let result = type.formattingPattern; + const typeRefs = []; + for (const typeRef of type.types ?? []) { + if (isJsiiType(typeRef)) { + typeRefs.push(linkFormatter(typeRef, metadata)); + } else { + typeRefs.push(defaultTypeFormatter(typeRef, metadata, linkFormatter)); + } + } + + // substitute referred types into the original string + const placeholderMatcher = /\%/g; + for (const typeRef of typeRefs) { + const matches = placeholderMatcher.exec(result); + if (!matches) { + // it's possible the number of %'s doesn't match the number of types provided + // e.g. csharp unions are currently rendered to `{ name: 'object', types: [type1, type2] }` + continue; + } + const insertionIdx: number = matches.index; + result = result.substring(0, insertionIdx) + typeRef + result.substring(insertionIdx + 1); + } + + return result; +}; \ No newline at end of file diff --git a/src/docgen/schema.ts b/src/docgen/schema.ts new file mode 100644 index 00000000..e076420e --- /dev/null +++ b/src/docgen/schema.ts @@ -0,0 +1,504 @@ +import * as jsii from 'jsii-reflect'; + +/** + * Describes any kind of type. This could be a primitive, a user-defined type + * (like `Bucket`), or a composition of types (like `Map[]`). + */ +export interface TypeSchema { + /** + * The language-specific name of the type. May contain "%" placeholder + * values to indicate references to types defined in the "types" field. + * + * @example "string" + * @example "%" + * @example "typing.List[%]" + * @example "Map<%, %>" + */ + readonly formattingPattern: string; + + /** + * Types referenced within the "name" field. The order of these corresponds + * to the order of the %'s in `formattingPattern`. + */ + readonly types?: (TypeSchema | JsiiEntity)[]; +} + +/** + * Describes a single "entity" in the jsii type system. This may be a type, + * but it could also be a property, method, parameter, enum member, etc. + */ +export interface JsiiEntity extends AssemblyMetadataSchema { + /** + * An id that uniquely identifies this type among all entities in the + * document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the entity. + */ + readonly displayName: string; + + /** + * The language-specific type FQN. + */ + readonly fqn: string; +} + +/** + * Describes a property. + */ +export interface PropertySchema extends Usage, Optional, Documentable { + /** + * An id that uniquely identifies this property among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the property. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * The type of the property. + */ + readonly type: TypeSchema; + + /** + * Whether the property is a constant. + * @default false + */ + readonly const?: boolean; +} + +/** + * Describes a parameter. + */ +export interface ParameterSchema extends Optional, Documentable { + /** + * An id that uniquely identifies this parameter among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the parameter. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * The type of the parameter. + */ + readonly type: TypeSchema; + +} + +/** + * Common properties of a callable. + */ +export interface CallableSchema extends Usage { + /** + * An id that uniquely identifies this callable among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the callable. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * Parameters of the callable. + */ + readonly parameters: ParameterSchema[]; +} + +/** + * Describes a constructor. + */ +export interface InitializerSchema extends CallableSchema {} + +/** + * Describes a method. + */ +export interface MethodSchema extends CallableSchema, Documentable {} + +/** + * Describes a class. + */ +export interface ClassSchema extends Documentable { + /** + * An id that uniquely identifies this class among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the class. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * Interfaces this class implements. + */ + readonly interfaces: JsiiEntity[]; + + /** + * Class initializer. + */ + readonly initializer?: InitializerSchema; + + /** + * Instance methods. + */ + readonly instanceMethods: MethodSchema[]; + + /** + * Static methods. + */ + readonly staticMethods: MethodSchema[]; + + /** + * Properties. + */ + readonly properties: PropertySchema[]; + + /** + * Constants. + */ + readonly constants: PropertySchema[]; +} + +/** + * Describes a construct. + */ +export interface ConstructSchema extends ClassSchema {} + +/** + * Describes a struct. + */ +export interface StructSchema extends Usage, Documentable { + /** + * An id that uniquely identifies this struct among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the struct. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * Properties. + */ + readonly properties: PropertySchema[]; +} + +/** + * Describes a behavioral interface, also sometimes known as a protocol. + */ +export interface InterfaceSchema extends Documentable { + /** + * An id that uniquely identifies this interface among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the interface. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * Interfaces that this interface extends. + */ + readonly interfaces: JsiiEntity[]; + + /** + * Types implementing this interface. + */ + readonly implementations: JsiiEntity[]; + + /** + * Methods. + */ + readonly instanceMethods: MethodSchema[]; + + /** + * Properties. + */ + readonly properties: PropertySchema[]; +} + +/** + * Describes an enum member. + */ +export interface EnumMemberSchema extends Documentable { + /** + * An id that uniquely identifies this enum member among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the enum member. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; +} + +/** + * Describes an enum. + */ +export interface EnumSchema extends Documentable { + /** + * An id that uniquely identifies this enum among all entities in + * the document and is same across languages. + */ + readonly id: string; + + /** + * The friendly language-specific name for the enum. + */ + readonly displayName: string; + + /** + * The language-specific fqn. + */ + readonly fqn: string; + + /** + * Enum members. + */ + readonly members: EnumMemberSchema[]; +} + +/** + * Describes the API Reference. + */ +export interface ApiReferenceSchema { + + /** + * Constructs. + */ + readonly constructs: ConstructSchema[]; + + /** + * Classes. + */ + readonly classes: ClassSchema[]; + + /** + * Structs. + */ + readonly structs: StructSchema[]; + + /** + * Interfaces. + */ + readonly interfaces: InterfaceSchema[]; + + /** + * Enums. + */ + readonly enums: EnumSchema[]; +} + +/** + * Metadata about a particular jsii assembly. + */ +export interface AssemblyMetadataSchema { + /** + * Name of the jsii assembly/package. + */ + readonly packageName: string; + + /** + * Version of the jsii assembly/package. + */ + readonly packageVersion: string; + + /** + * Name of the submodule within the jsii assembly (if undefined, this is the + * root module). + */ + readonly submodule?: string; +} + +/** + * Describes the top-level schema. + */ +export interface Schema { + /** + * Schema version number. + */ + readonly version: string; + + /** + * Language that the documentation has been transliterated to. + */ + readonly language: string; + + /** + * Assembly metadata. + */ + readonly metadata: AssemblyMetadataSchema; + + /** + * Readme. + */ + readonly readme?: string; + + /** + * API Reference. + */ + readonly apiReference?: ApiReferenceSchema; +} + + +// +// SHARED INTERFACES +// + +/** + * An entity that can have a doc string. + */ +export interface Documentable { + /** + * Doc string. + */ + readonly docs: DocsSchema; +} + +/** + * Docstring information. + * + * @see jsii.Docs + */ +export interface DocsSchema { + /** + * Summary documentation for an API item. + * + * The first part of the documentation before hitting a `@remarks` tags, or + * the first line of the doc comment block if there is no `@remarks` tag. + */ + readonly summary?: string; + + /** + * Detailed information about an API item. + * + * Either the explicitly tagged `@remarks` section, otherwise everything + * past the first paragraph if there is no `@remarks` tag. + */ + readonly remarks?: string; + + /** + * `@see` and `@link` links with more information. + */ + readonly links?: string[]; + + /** + * Whether or not it is deprecated. + */ + readonly deprecated?: boolean; + + /** + * Deprecation reason (if applicable). + */ + readonly deprecationReason?: string; +} + +/** + * An entity that may include a code snippet showing how to use it. + */ +export interface Usage { + /** + * Code snippet. + * @default - none + */ + readonly usage?: string; +} + +/** + * An entity that may be optional. + */ +export interface Optional { + /** + * Whether or not it is optional. + * @default false + */ + readonly optional?: boolean; + + /** + * The default value, if applicable. + * @default - none + */ + readonly default?: string; +} + +export function extractDocs(docs: jsii.Docs): DocsSchema { + const links = []; + const see = docs.docs.see; // @see + if (see && see.length > 0) { + links.push(see); + } + const link = docs.customTag('link'); // @link + if (link && link.length > 0) { + links.push(link); + } + return filterUndefined({ + // ignore defaults and empty strings to save space + summary: docs.summary.length > 0 ? docs.summary : undefined, + remarks: docs.remarks.length > 0 ? docs.remarks : undefined, + links: links.length > 0 ? links : undefined, + deprecated: docs.deprecated === true ? true : undefined, + deprecationReason: docs.deprecationReason, + }); +} + +function filterUndefined(obj: T): T { + const ret: any = {}; + for (const [k, v] of Object.entries(obj)) { + if (v !== undefined) { + ret[k] = v; + } + } + return ret; +} diff --git a/src/docgen/transpile/csharp.ts b/src/docgen/transpile/csharp.ts index 434c48d6..841496fe 100644 --- a/src/docgen/transpile/csharp.ts +++ b/src/docgen/transpile/csharp.ts @@ -43,7 +43,7 @@ export class CSharpTranspile extends transpile.TranspileBase { } fqn.push(type.name); - return { + return new transpile.TranspiledType({ fqn: fqn.join('.'), name: type.name, namespace: namespace, @@ -51,7 +51,7 @@ export class CSharpTranspile extends transpile.TranspileBase { submodule: moduleLike.submodule, source: type, language: this.language, - }; + }); } public callable(callable: reflect.Callable): transpile.TranspiledCallable { diff --git a/src/docgen/transpile/java.ts b/src/docgen/transpile/java.ts index 08762f8e..070c9e28 100644 --- a/src/docgen/transpile/java.ts +++ b/src/docgen/transpile/java.ts @@ -36,7 +36,7 @@ const propertyToParameter = ( method: callable, name: property.name, optional: property.optional, - parentType: property.parentType, + parentType: callable.parentType, spec: property.spec, system: property.system, type: property.type, @@ -100,7 +100,7 @@ export class JavaTranspile extends transpile.TranspileBase { } fqn.push(type.name); - return { + return new transpile.TranspiledType({ fqn: fqn.join('.'), name: type.name, namespace: namespace, @@ -108,7 +108,7 @@ export class JavaTranspile extends transpile.TranspileBase { submodule: moduleLike.submodule, source: type, language: this.language, - }; + }); } public callable(callable: reflect.Callable): transpile.TranspiledCallable { diff --git a/src/docgen/transpile/python.ts b/src/docgen/transpile/python.ts index 3950f827..bfb3a564 100644 --- a/src/docgen/transpile/python.ts +++ b/src/docgen/transpile/python.ts @@ -67,7 +67,7 @@ const propertyToParameter = ( method: callable, name: property.name, optional: property.optional, - parentType: property.parentType, + parentType: callable.parentType, spec: property.spec, system: property.system, type: property.type, @@ -228,7 +228,7 @@ export class PythonTranspile extends transpile.TranspileBase { } fqn.push(type.name); - return { + return new transpile.TranspiledType({ fqn: fqn.join('.'), name: type.name, namespace: type.namespace, @@ -236,7 +236,7 @@ export class PythonTranspile extends transpile.TranspileBase { submodule: moduleLike.submodule, source: type, language: this.language, - }; + }); } public moduleLike( diff --git a/src/docgen/transpile/transpile.ts b/src/docgen/transpile/transpile.ts index 331b7174..553cc8d5 100644 --- a/src/docgen/transpile/transpile.ts +++ b/src/docgen/transpile/transpile.ts @@ -1,4 +1,5 @@ import * as reflect from 'jsii-reflect'; +import { JsiiEntity, TypeSchema } from '../schema'; /** * Supported languages to generate documentation in. @@ -180,38 +181,67 @@ export interface TranspiledInterface { /** * Outcome of transpiling a generic jsii type. */ -export interface TranspiledType { +export class TranspiledType { /** * The source type this was transliterated from. */ - readonly source: reflect.Type; + public readonly source: reflect.Type; /** * The transliteration language. */ - readonly language: Language; + public readonly language: Language; /** * The language specific fqn. */ - readonly fqn: string; + public readonly fqn: string; /** * Simple name of the type. */ - readonly name: string; + public readonly name: string; /** * Namespace of the type. */ - readonly namespace?: string; + public readonly namespace?: string; /** * The language specific module name the type belongs to. */ - readonly module: string; + public readonly module: string; /** * The language specific submodule name the type belongs to. */ - readonly submodule?: string; + public readonly submodule?: string; + + public constructor(options: { + source: reflect.Type; + language: Language; + fqn: string; + name: string; + namespace?: string; + module: string; + submodule?: string; + }) { + this.source = options.source; + this.language = options.language; + this.fqn = options.fqn; + this.name = options.name; + this.namespace = options.namespace; + this.module = options.module; + this.submodule = options.submodule; + } + + toJson(): JsiiEntity { + return { + fqn: this.fqn, + displayName: this.name, + id: this.source.fqn, + packageName: this.source.assembly.name, + packageVersion: this.source.assembly.version, + submodule: this.submodule, + }; + } } /** @@ -285,7 +315,7 @@ export class TranspiledTypeReference { ); } /** - * Create a type reference that reprenets a map of a type reference. + * Create a type reference that represents a map of a type reference. */ public static mapOfType( transpile: Transpile, @@ -303,7 +333,7 @@ export class TranspiledTypeReference { ); } /** - * Create a type reference that reprenets a union of a type references. + * Create a type reference that represents a union of a type references. */ public static unionOfTypes( transpile: Transpile, @@ -383,6 +413,70 @@ export class TranspiledTypeReference { } throw new Error(`Invalid type reference: ${this.ref.toString()}`); } + + public toJson(): TypeSchema { + if (this.primitive) { + return { + formattingPattern: this.primitive, + }; + } + + if (this.type) { + if (!this.ref.fqn) { + throw new Error(`Original type reference for ${this.type.fqn} does not have a fqn.`); + } + + // If we are running in a test, report a fake stable version since types + // may belong to dependency packages, which could be specified with caret + // dependencies - this means the packageVersion of a type like + // `construct.Construct` will be set to whichever version is installed. + // This is okay in practice, but makes snapshot tests inconsistent. + const IS_TEST_RUN = process.env.NODE_ENV === 'test'; + const packageVersion = IS_TEST_RUN ? '99.99.99' : this.type.source.assembly.version; + + return { + formattingPattern: '%', + types: [ + { + id: this.ref.fqn, + displayName: this.type.name, + fqn: this.type.fqn, + packageName: this.type.source.assembly.name, + packageVersion, + submodule: this.type.submodule, + }, + ], + }; + } + + if (this.isAny) { + return { + formattingPattern: this.transpile.any(), + }; + } + + if (this.arrayOfType) { + return { + formattingPattern: this.transpile.listOf('%'), + types: [this.arrayOfType.toJson()], + }; + } + if (this.mapOfType) { + return { + formattingPattern: this.transpile.mapOf('%'), + types: [this.mapOfType.toJson()], + }; + } + if (this.unionOfTypes) { + const inner = Array(this.unionOfTypes.length).fill('%'); + return { + formattingPattern: this.transpile.unionOf(inner), + types: this.unionOfTypes.map((t) => t.toJson()), + }; + } + + throw new Error(`Invalid type reference: ${this.ref.toString()}`); + } } /** diff --git a/src/docgen/transpile/typescript.ts b/src/docgen/transpile/typescript.ts index 5cee4252..ded10ff3 100644 --- a/src/docgen/transpile/typescript.ts +++ b/src/docgen/transpile/typescript.ts @@ -193,7 +193,7 @@ export class TypeScriptTranspile extends transpile.TranspileBase { } fqn.push(type.name); - return { + return new transpile.TranspiledType({ fqn: fqn.join('.'), name: type.name, namespace: type.namespace, @@ -201,7 +201,7 @@ export class TypeScriptTranspile extends transpile.TranspileBase { submodule: moduleLike.submodule, source: type, language: this.language, - }; + }); } public moduleLike( diff --git a/src/docgen/view/api-reference.ts b/src/docgen/view/api-reference.ts index 56f025d0..20675a33 100644 --- a/src/docgen/view/api-reference.ts +++ b/src/docgen/view/api-reference.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { ApiReferenceSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Classes } from './classes'; import { Constructs } from './constructs'; import { Enums } from './enums'; @@ -19,7 +19,6 @@ export class ApiReference { constructor( transpile: Transpile, assembly: reflect.Assembly, - linkFormatter: (type: TranspiledType) => string, submodule?: reflect.Submodule, ) { const classes = this.sortByName( @@ -30,24 +29,24 @@ export class ApiReference { ); const enums = this.sortByName(submodule ? submodule.enums : assembly.enums); - this.constructs = new Constructs(transpile, classes, linkFormatter); - this.classes = new Classes(transpile, classes, linkFormatter); - this.structs = new Structs(transpile, interfaces, linkFormatter); - this.interfaces = new Interfaces(transpile, interfaces, linkFormatter); + this.constructs = new Constructs(transpile, classes); + this.classes = new Classes(transpile, classes); + this.structs = new Structs(transpile, interfaces); + this.interfaces = new Interfaces(transpile, interfaces); this.enums = new Enums(transpile, enums); } /** - * Generate markdown. + * Generate JSON. */ - public render(): Markdown { - const md = new Markdown({ header: { title: 'API Reference' } }); - md.section(this.constructs.render()); - md.section(this.structs.render()); - md.section(this.classes.render()); - md.section(this.interfaces.render()); - md.section(this.enums.render()); - return md; + public toJson(): ApiReferenceSchema { + return { + constructs: this.constructs.toJson(), + classes: this.classes.toJson(), + structs: this.structs.toJson(), + interfaces: this.interfaces.toJson(), + enums: this.enums.toJson(), + }; } private sortByName(arr: readonly Type[]): Type[] { diff --git a/src/docgen/view/class.ts b/src/docgen/view/class.ts index 38cd3d91..0671aa01 100644 --- a/src/docgen/view/class.ts +++ b/src/docgen/view/class.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledClass, TranspiledType } from '../transpile/transpile'; +import { ClassSchema, extractDocs } from '../schema'; +import { Transpile, TranspiledClass } from '../transpile/transpile'; import { Constants } from './constants'; import { Initializer } from './initializer'; import { InstanceMethods } from './instance-methods'; @@ -31,46 +31,30 @@ export class Class { constructor( private readonly transpile: Transpile, private readonly klass: reflect.ClassType, - private readonly linkFormatter: (type: TranspiledType) => string, ) { if (klass.initializer) { - this.initializer = new Initializer(transpile, klass.initializer, linkFormatter); + this.initializer = new Initializer(transpile, klass.initializer); } - this.instanceMethods = new InstanceMethods(transpile, klass.ownMethods, linkFormatter); - this.staticFunctions = new StaticFunctions(transpile, klass.ownMethods, linkFormatter); - this.constants = new Constants(transpile, klass.ownProperties, linkFormatter); - this.properties = new Properties(transpile, klass.ownProperties, linkFormatter); + this.instanceMethods = new InstanceMethods(transpile, klass.ownMethods); + this.staticFunctions = new StaticFunctions(transpile, klass.ownMethods); + this.constants = new Constants(transpile, klass.ownProperties); + this.properties = new Properties(transpile, klass.ownProperties); this.transpiled = transpile.class(klass); } - public render(): Markdown { - const md = new Markdown({ - id: this.transpiled.type.fqn, - header: { title: this.transpiled.name }, - }); - - if (this.klass.interfaces.length > 0) { - const ifaces = []; - for (const iface of this.klass.interfaces) { - const transpiled = this.transpile.type(iface); - ifaces.push(`[${Markdown.pre(transpiled.fqn)}](${this.linkFormatter(transpiled)})`); - } - md.bullet(`${Markdown.italic('Implements:')} ${ifaces.join(', ')}`); - md.lines(''); - } - - if (this.klass.docs) { - md.docs(this.klass.docs); - } - - if (this.initializer) { - md.section(this.initializer.render()); - } - - md.section(this.instanceMethods.render()); - md.section(this.staticFunctions.render()); - md.section(this.properties.render()); - md.section(this.constants.render()); - return md; + public toJson(): ClassSchema { + const interfaces = this.klass.interfaces.map((iface) => this.transpile.type(iface).toJson()); + return { + initializer: this.initializer?.toJson(), + interfaces: interfaces, + instanceMethods: this.instanceMethods.toJson(), + staticMethods: this.staticFunctions.toJson(), + constants: this.constants.toJson(), + properties: this.properties.toJson(), + fqn: this.transpiled.type.fqn, + displayName: this.transpiled.type.fqn.split('.').pop()!, + id: this.klass.fqn, + docs: extractDocs(this.klass.docs), + }; } } diff --git a/src/docgen/view/classes.ts b/src/docgen/view/classes.ts index 49398d64..4173cefd 100644 --- a/src/docgen/view/classes.ts +++ b/src/docgen/view/classes.ts @@ -1,25 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { ClassSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Class } from './class'; export class Classes { private readonly classes: Class[]; - constructor(transpile: Transpile, classes: reflect.ClassType[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, classes: reflect.ClassType[]) { this.classes = classes .filter((c) => !Class.isConstruct(c)) - .map((c) => new Class(transpile, c, linkFormatter)); + .map((c) => new Class(transpile, c)); } - public render(): Markdown { - if (this.classes.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Classes' } }); - for (const klass of this.classes) { - md.section(klass.render()); - } - return md; + public toJson(): ClassSchema[] { + return this.classes.map((klass) => klass.toJson()); } } diff --git a/src/docgen/view/constant.ts b/src/docgen/view/constant.ts index fb36be07..332a40a2 100644 --- a/src/docgen/view/constant.ts +++ b/src/docgen/view/constant.ts @@ -1,31 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { PropertySchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Property } from './property'; export class Constant { private readonly constant: Property; - constructor(transpile: Transpile, property: reflect.Property, linkFormatter: (type: TranspiledType) => string) { - this.constant = new Property(transpile, property, linkFormatter); + constructor(transpile: Transpile, property: reflect.Property) { + this.constant = new Property(transpile, property); } - public get id(): string { - return this.constant.id; - } - - public get linkedName(): string { - return this.constant.linkedName; - } - - public get type(): string { - return this.constant.type; - } - - public get description(): string { - return this.constant.description; - } - - public render(): Markdown { - return this.constant.render(); + public toJson(): PropertySchema { + return { + ...this.constant.toJson(), + const: true, + }; } } diff --git a/src/docgen/view/constants.ts b/src/docgen/view/constants.ts index 0380234e..37009869 100644 --- a/src/docgen/view/constants.ts +++ b/src/docgen/view/constants.ts @@ -1,32 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { PropertySchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Constant } from './constant'; export class Constants { private readonly constants: Constant[]; - constructor(transpile: Transpile, properties: reflect.Property[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, properties: reflect.Property[]) { this.constants = properties .filter((p) => !p.protected && p.const) - .map((p) => new Constant(transpile, p, linkFormatter)); + .map((p) => new Constant(transpile, p)); } - public render(): Markdown { - if (this.constants.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Constants' } }); - - md.table([ - ['Name', 'Type', 'Description'].map(Markdown.bold), - ...this.constants.map((constant) => [constant.linkedName, constant.type, Markdown.sanitize(constant.description)]), - ]); - md.split(); - - for (const c of this.constants) { - md.section(c.render()); - } - return md; + public toJson(): PropertySchema[] { + return this.constants.map((c) => c.toJson()); } } diff --git a/src/docgen/view/construct.ts b/src/docgen/view/construct.ts index 2ddc7754..2fc74fd5 100644 --- a/src/docgen/view/construct.ts +++ b/src/docgen/view/construct.ts @@ -1,14 +1,15 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { ConstructSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Class } from './class'; export class Construct { private readonly construct: Class; - constructor(transpile: Transpile, klass: reflect.ClassType, linkFormatter: (type: TranspiledType) => string) { - this.construct = new Class(transpile, klass, linkFormatter); + constructor(transpile: Transpile, klass: reflect.ClassType) { + this.construct = new Class(transpile, klass); } - public render(): Markdown { - return this.construct.render(); + + public toJson(): ConstructSchema { + return this.construct.toJson(); } } diff --git a/src/docgen/view/constructs.ts b/src/docgen/view/constructs.ts index 3d6aeb90..726ef507 100644 --- a/src/docgen/view/constructs.ts +++ b/src/docgen/view/constructs.ts @@ -1,26 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { ConstructSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Class } from './class'; import { Construct } from './construct'; export class Constructs { private readonly constructs: Construct[]; - constructor(transpile: Transpile, classes: reflect.ClassType[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, classes: reflect.ClassType[]) { this.constructs = classes .filter((c) => Class.isConstruct(c)) - .map((c) => new Construct(transpile, c, linkFormatter)); + .map((c) => new Construct(transpile, c)); } - public render(): Markdown { - if (this.constructs.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Constructs' } }); - for (const construct of this.constructs) { - md.section(construct.render()); - } - return md; + public toJson(): ConstructSchema[] { + return this.constructs.map((construct) => construct.toJson()); } } diff --git a/src/docgen/view/documentation.ts b/src/docgen/view/documentation.ts index a15cbc9c..a8281149 100644 --- a/src/docgen/view/documentation.ts +++ b/src/docgen/view/documentation.ts @@ -6,11 +6,14 @@ import * as reflect from 'jsii-reflect'; import { TargetLanguage } from 'jsii-rosetta'; import { transliterateAssembly } from 'jsii-rosetta/lib/commands/transliterate'; import { CorruptedAssemblyError, LanguageNotSupportedError } from '../..'; -import { Markdown } from '../render/markdown'; +import { Json } from '../render/json'; +import { MarkdownDocument } from '../render/markdown-doc'; +import { MarkdownFormattingOptions, MarkdownRenderer } from '../render/markdown-render'; +import { Schema } from '../schema'; import { CSharpTranspile } from '../transpile/csharp'; import { JavaTranspile } from '../transpile/java'; import { PythonTranspile } from '../transpile/python'; -import { Transpile, Language, TranspiledType } from '../transpile/transpile'; +import { Transpile, Language } from '../transpile/transpile'; import { TypeScriptTranspile } from '../transpile/typescript'; import { Npm } from './_npm'; import { ApiReference } from './api-reference'; @@ -23,20 +26,17 @@ const NOT_FOUND_IN_ASSEMBLY_REGEX = /Type '(.*)\..*' not found in assembly (.*)$ * Options for rendering a `Documentation` object. */ export interface RenderOptions { - /** * Which language to generate docs for. - * - * @default Language.TYPESCRIPT */ - readonly language?: Language; + readonly language: Language; /** - * Whether to ignore missing fixture files that will prevent transliterating - * some code snippet examples. - * - * @default true - */ + * Whether to ignore missing fixture files that will prevent transliterating + * some code snippet examples. + * + * @default true + */ readonly loose?: boolean; /** @@ -47,28 +47,22 @@ export interface RenderOptions { readonly apiReference?: boolean; /** - * Include the user defined README.md in the documentation. - * - * @default true - */ + * Include the user defined README.md in the documentation. + * + * @default true + */ readonly readme?: boolean; /** - * Generate documentation only for a specific submodule. - * - * @default - Documentation is generated for the root module only. - */ - readonly submodule?: string; - - /** - * How should links to types be rendered. + * Generate documentation only for a specific submodule. * - * @default '#{fqn}' + * @default - Documentation is generated for the root module only. */ - readonly linkFormatter?: (type: TranspiledType) => string; - + readonly submodule?: string; } +export interface MarkdownRenderOptions extends RenderOptions, MarkdownFormattingOptions {} + /** * Options for creating a `Documentation` object using the `fromLocalPackage` function. */ @@ -175,7 +169,7 @@ export class Documentation { /** * Generate markdown. */ - public async render(options: RenderOptions = {}): Promise { + public async toJson(options: RenderOptions): Promise> { const language = options.language ?? Language.TYPESCRIPT; const loose = options.loose ?? true; @@ -197,17 +191,16 @@ export class Documentation { } const submodule = options?.submodule ? this.findSubmodule(assembly, options.submodule) : undefined; - const documentation = new Markdown(); + let readme: MarkdownDocument | undefined; if (options?.readme ?? true) { - const readme = new Readme(transpile, assembly, submodule); - documentation.section(readme.render()); + readme = new Readme(transpile, assembly, submodule).render(); } + let apiReference: ApiReference | undefined; if (options?.apiReference ?? true) { try { - const apiReference = new ApiReference(transpile, assembly, options?.linkFormatter ?? ((t: TranspiledType) => `#${t.fqn}`), submodule); - documentation.section(apiReference.render()); + apiReference = new ApiReference(transpile, assembly, submodule); } catch (error) { if (!(error instanceof Error)) { throw error; @@ -216,7 +209,26 @@ export class Documentation { } } - return documentation; + return new Json({ + version: '0.1', + language: language.toString(), + metadata: { + packageName: assembly.name, + packageVersion: assembly.version, + submodule: submodule?.name, + }, + readme: readme?.render(), + apiReference: apiReference?.toJson(), + }); + } + + public async toMarkdown(options: MarkdownRenderOptions): Promise { + const json = (await this.toJson(options)).content; + return MarkdownRenderer.fromSchema(json, { + anchorFormatter: options.anchorFormatter, + linkFormatter: options.linkFormatter, + typeFormatter: options.typeFormatter, + }); } private addCleanupDirectory(directory: string) { @@ -234,29 +246,8 @@ export class Documentation { } private async languageSpecific(lang: Language, loose: boolean): Promise<{ assembly: reflect.Assembly; transpile: Transpile}> { - - let language, transpile = undefined; - - switch (lang) { - case Language.PYTHON: - language = TargetLanguage.PYTHON; - transpile = new PythonTranspile(); - break; - case Language.TYPESCRIPT: - transpile = new TypeScriptTranspile(); - break; - case Language.JAVA: - language = TargetLanguage.JAVA; - transpile = new JavaTranspile(); - break; - case Language.CSHARP: - transpile = new CSharpTranspile(); - language = TargetLanguage.CSHARP; - break; - default: - throw new Error(`Unsupported language: ${lang}. Supported languages are ${Object.values(Language)}`); - } - return { assembly: await this.createAssembly(loose, language), transpile }; + const { rosettaTarget, transpile } = LANGUAGE_SPECIFIC[lang.toString()]; + return { assembly: await this.createAssembly(loose, rosettaTarget), transpile }; } /** @@ -315,6 +306,25 @@ export class Documentation { } +export const LANGUAGE_SPECIFIC = { + [Language.PYTHON.toString()]: { + transpile: new PythonTranspile(), + rosettaTarget: TargetLanguage.PYTHON, + }, + [Language.TYPESCRIPT.toString()]: { + transpile: new TypeScriptTranspile(), + rosettaTarget: undefined, // no transpilation needed + }, + [Language.JAVA.toString()]: { + transpile: new JavaTranspile(), + rosettaTarget: TargetLanguage.JAVA, + }, + [Language.CSHARP.toString()]: { + transpile: new CSharpTranspile(), + rosettaTarget: TargetLanguage.CSHARP, + }, +}; + async function withTempDir(work: (workdir: string) => Promise): Promise { const workdir = await fs.mkdtemp(path.join(os.tmpdir(), path.sep)); const cwd = process.cwd(); diff --git a/src/docgen/view/enum-member.ts b/src/docgen/view/enum-member.ts index 538356ce..f59db133 100644 --- a/src/docgen/view/enum-member.ts +++ b/src/docgen/view/enum-member.ts @@ -1,5 +1,5 @@ import * as reflect from 'jsii-reflect'; -import { anchorForId, Markdown } from '../render/markdown'; +import { EnumMemberSchema, extractDocs } from '../schema'; import { Transpile, TranspiledEnumMember } from '../transpile/transpile'; export class EnumMember { @@ -8,43 +8,12 @@ export class EnumMember { this.transpiled = transpile.enumMember(em); } - public get id(): string { - return `${this.transpiled.fqn}`; - } - - public get linkedName(): string { - return `[${Markdown.pre(this.transpiled.name)}](#${anchorForId(this.id)})`; - } - - public get description(): string { - const summary = this.em.docs.summary; - return summary.length > 0 ? summary : Markdown.italic('No description.'); - } - - public render(): Markdown { - const md = new Markdown({ - id: this.id, - header: { - title: this.transpiled.name, - pre: true, - strike: this.em.docs.deprecated, - }, - }); - - if (this.em.docs.deprecated) { - md.bullet( - `${Markdown.italic('Deprecated:')} ${this.em.docs.deprecationReason}`, - ); - md.lines(''); - } - - if (this.em.docs) { - md.docs(this.em.docs); - } - - md.split(); - md.lines(''); - - return md; + public toJson(): EnumMemberSchema { + return { + id: `${this.em.enumType.fqn}.${this.em.name}`, + displayName: this.em.name, + fqn: this.transpiled.fqn, + docs: extractDocs(this.em.docs), + }; } } diff --git a/src/docgen/view/enum.ts b/src/docgen/view/enum.ts index 122a66ce..9a32f1ea 100644 --- a/src/docgen/view/enum.ts +++ b/src/docgen/view/enum.ts @@ -1,35 +1,26 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile } from '../transpile/transpile'; +import { EnumSchema, extractDocs } from '../schema'; +import { Transpile, TranspiledEnum } from '../transpile/transpile'; import { EnumMember } from './enum-member'; export class Enum { + private readonly transpiled: TranspiledEnum; private readonly members: EnumMember[]; constructor( private readonly transpile: Transpile, private readonly enu: reflect.EnumType, ) { + this.transpiled = this.transpile.enum(this.enu); this.members = enu.members.map((em) => new EnumMember(transpile, em)); } - public render(): Markdown { - const transpiled = this.transpile.enum(this.enu); - const md = new Markdown({ header: { title: transpiled.name } }); - - md.table([ - ['Name', 'Description'].map(Markdown.bold), - ...this.members.map((member) => [member.linkedName, Markdown.sanitize(member.description)]), - ]); - md.split(); - - if (this.enu.docs) { - md.docs(this.enu.docs); - } - - for (const m of this.members) { - md.section(m.render()); - } - - return md; + public toJson(): EnumSchema { + return { + fqn: this.transpiled.fqn, + displayName: this.transpiled.fqn.split('.').pop()!, + id: this.enu.fqn, + members: this.members.map((em) => em.toJson()), + docs: extractDocs(this.enu.docs), + }; } } diff --git a/src/docgen/view/enums.ts b/src/docgen/view/enums.ts index dddbcf06..89a92ee3 100644 --- a/src/docgen/view/enums.ts +++ b/src/docgen/view/enums.ts @@ -1,5 +1,5 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; +import { EnumSchema } from '../schema'; import { Transpile } from '../transpile/transpile'; import { Enum } from './enum'; @@ -9,15 +9,7 @@ export class Enums { this.enums = enums.map((e) => new Enum(transpile, e)); } - public render(): Markdown { - if (this.enums.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Enums' } }); - for (const e of this.enums) { - md.section(e.render()); - } - return md; + public toJson(): EnumSchema[] { + return this.enums.map((enu) => enu.toJson()); } } diff --git a/src/docgen/view/initializer.ts b/src/docgen/view/initializer.ts index 1dba8613..6fd4234b 100644 --- a/src/docgen/view/initializer.ts +++ b/src/docgen/view/initializer.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledCallable, TranspiledType } from '../transpile/transpile'; +import { InitializerSchema } from '../schema'; +import { Transpile, TranspiledCallable } from '../transpile/transpile'; import { Parameter } from './parameter'; export class Initializer { @@ -8,40 +8,21 @@ export class Initializer { private readonly parameters: Parameter[]; constructor( private readonly transpile: Transpile, - initializer: reflect.Initializer, - linkFormatter: (type: TranspiledType) => string, + private readonly initializer: reflect.Initializer, ) { this.transpiled = transpile.callable(initializer); this.parameters = this.transpiled.parameters.map( - (p) => new Parameter(this.transpile, p, linkFormatter), + (p) => new Parameter(this.transpile, p), ); } - public render(): Markdown { - const md = new Markdown({ - id: `${this.transpiled.parentType.fqn}.Initializer`, - header: { - title: 'Initializers', - }, - }); - - md.code( - this.transpile.language.toString(), - `${this.transpiled.import}`, - '', - ...this.transpiled.invocations, - ); - - md.table([ - ['Name', 'Type', 'Description'].map(Markdown.bold), - ...this.parameters.map((param) => [param.linkedName, param.type, Markdown.sanitize(param.description)]), - ]); - md.split(); - - for (const parameter of this.parameters) { - md.section(parameter.render()); - } - - return md; + public toJson(): InitializerSchema { + return { + fqn: `${this.transpiled.parentType.fqn}.Initializer`, + displayName: 'Initializer', + id: `${this.initializer.parentType.fqn}.Initializer`, + parameters: this.parameters.map((param) => param.toJson()), + usage: `${this.transpiled.import}\n\n${this.transpiled.invocations}`, + }; } } diff --git a/src/docgen/view/instance-method.ts b/src/docgen/view/instance-method.ts index 75746279..69ba4b84 100644 --- a/src/docgen/view/instance-method.ts +++ b/src/docgen/view/instance-method.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { anchorForId, Markdown } from '../render/markdown'; -import { Transpile, TranspiledCallable, TranspiledType } from '../transpile/transpile'; +import { extractDocs, MethodSchema } from '../schema'; +import { Transpile, TranspiledCallable } from '../transpile/transpile'; import { Parameter } from './parameter'; export class InstanceMethod { @@ -9,43 +9,21 @@ export class InstanceMethod { constructor( private readonly transpile: Transpile, private readonly method: reflect.Method, - linkFormatter: (type: TranspiledType) => string, ) { this.transpiled = transpile.callable(method); this.parameters = this.transpiled.parameters.map( - (p) => new Parameter(this.transpile, p, linkFormatter), + (p) => new Parameter(this.transpile, p), ); } - public get id(): string { - return `${this.transpiled.parentType.fqn}.${this.transpiled.name}`; - } - - public get linkedName(): string { - return `[${Markdown.pre(this.transpiled.name)}](#${anchorForId(this.id)})`; - } - - public get description(): string { - const summary = this.method.docs.summary; - return summary.length > 0 ? summary : Markdown.italic('No description.'); - } - - public render(): Markdown { - const md = new Markdown({ - id: this.id, - header: { - title: this.transpiled.name, - pre: true, - strike: this.method.docs.deprecated, - }, - }); - - md.code(this.transpile.language.toString(), this.transpiled.signatures.join('\n')); - - for (const parameter of this.parameters) { - md.section(parameter.render()); - } - - return md; + public toJson(): MethodSchema { + return { + fqn: `${this.transpiled.parentType.fqn}.${this.transpiled.name}`, + displayName: this.transpiled.name, + id: `${this.method.definingType.fqn}.${this.method.name}`, + parameters: this.parameters.map((p) => p.toJson()), + docs: extractDocs(this.method.docs), + usage: this.transpiled.signatures.join('\n'), + }; } } diff --git a/src/docgen/view/instance-methods.ts b/src/docgen/view/instance-methods.ts index e97efe8b..71c45edc 100644 --- a/src/docgen/view/instance-methods.ts +++ b/src/docgen/view/instance-methods.ts @@ -1,32 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { MethodSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { InstanceMethod } from './instance-method'; export class InstanceMethods { private readonly instanceMethods: InstanceMethod[]; - constructor(transpile: Transpile, methods: reflect.Method[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, methods: reflect.Method[]) { this.instanceMethods = methods .filter((m) => !m.protected && !m.static) - .map((m) => new InstanceMethod(transpile, m, linkFormatter)); + .map((m) => new InstanceMethod(transpile, m)); } - public render(): Markdown { - if (this.instanceMethods.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Methods' } }); - - md.table([ - ['Name', 'Description'].map(Markdown.bold), - ...this.instanceMethods.map((method) => [method.linkedName, Markdown.sanitize(method.description)]), - ]); - md.split(); - - for (const method of this.instanceMethods) { - md.section(method.render()); - } - return md; + public toJson(): MethodSchema[] { + return this.instanceMethods.map((m) => m.toJson()); } } diff --git a/src/docgen/view/interface.ts b/src/docgen/view/interface.ts index d2cd7e7c..f09eedd4 100644 --- a/src/docgen/view/interface.ts +++ b/src/docgen/view/interface.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledInterface, TranspiledType } from '../transpile/transpile'; +import { extractDocs, InterfaceSchema, JsiiEntity } from '../schema'; +import { Transpile, TranspiledInterface } from '../transpile/transpile'; import { InstanceMethods } from './instance-methods'; import { Properties } from './properties'; @@ -17,45 +17,24 @@ export class Interface { constructor( private readonly transpile: Transpile, private readonly iface: reflect.InterfaceType, - private readonly linkFormatter: (type: TranspiledType) => string, ) { this.transpiled = transpile.interface(iface); - this.instanceMethods = new InstanceMethods(transpile, iface.ownMethods, linkFormatter); - this.properties = new Properties(transpile, iface.allProperties, linkFormatter); + this.instanceMethods = new InstanceMethods(transpile, iface.ownMethods); + this.properties = new Properties(transpile, iface.allProperties); } - public render(): Markdown { - const md = new Markdown({ - id: this.transpiled.type.fqn, - header: { title: this.transpiled.name }, - }); - - if (this.iface.interfaces.length > 0) { - const ifaces = []; - for (const iface of this.iface.interfaces) { - const transpiled = this.transpile.type(iface); - ifaces.push(`[${Markdown.pre(transpiled.fqn)}](${this.linkFormatter(transpiled)})`); - } - md.bullet(`${Markdown.italic('Extends:')} ${ifaces.join(', ')}`); - md.lines(''); - } - - if (this.iface.allImplementations.length > 0) { - const impls = []; - for (const impl of this.iface.allImplementations) { - const transpiled = this.transpile.type(impl); - impls.push(`[${Markdown.pre(transpiled.fqn)}](${this.linkFormatter(transpiled)})`); - } - md.bullet(`${Markdown.italic('Implemented By:')} ${impls.join(', ')}`); - md.lines(''); - } - - if (this.iface.docs) { - md.docs(this.iface.docs); - } - - md.section(this.instanceMethods.render()); - md.section(this.properties.render()); - return md; + public toJson(): InterfaceSchema { + const impls: JsiiEntity[] = this.iface.allImplementations.map((impl) => this.transpile.type(impl).toJson()); + const bases: JsiiEntity[] = this.iface.interfaces.map((base) => this.transpile.type(base).toJson()); + return { + fqn: this.transpiled.type.fqn, + displayName: this.transpiled.type.fqn.split('.').pop()!, + id: this.iface.fqn, + implementations: impls, + interfaces: bases, + instanceMethods: this.instanceMethods.toJson(), + properties: this.properties.toJson(), + docs: extractDocs(this.iface.docs), + }; } } diff --git a/src/docgen/view/interfaces.ts b/src/docgen/view/interfaces.ts index 07619356..36e854d7 100644 --- a/src/docgen/view/interfaces.ts +++ b/src/docgen/view/interfaces.ts @@ -1,27 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { InterfaceSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Interface } from './interface'; export class Interfaces { private readonly interfaces: Interface[]; - constructor(transpile: Transpile, interfaces: reflect.InterfaceType[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, interfaces: reflect.InterfaceType[]) { this.interfaces = interfaces .filter((i) => !Interface.isStruct(i)) - .map((i) => new Interface(transpile, i, linkFormatter)); + .map((i) => new Interface(transpile, i)); } - public render(): Markdown { - if (this.interfaces.length === 0) { - return Markdown.EMPTY; - } - const md = new Markdown({ header: { title: 'Protocols' } }); - - for (const iface of this.interfaces) { - md.section(iface.render()); - } - - return md; + public toJson(): InterfaceSchema[] { + return this.interfaces.map((iface) => iface.toJson()); } } diff --git a/src/docgen/view/parameter.ts b/src/docgen/view/parameter.ts index a7957027..fe294fe2 100644 --- a/src/docgen/view/parameter.ts +++ b/src/docgen/view/parameter.ts @@ -1,77 +1,30 @@ import * as reflect from 'jsii-reflect'; -import { anchorForId, Markdown } from '../render/markdown'; -import { Transpile, TranspiledParameter, TranspiledType } from '../transpile/transpile'; +import { extractDocs, ParameterSchema } from '../schema'; +import { Transpile, TranspiledCallable, TranspiledParameter } from '../transpile/transpile'; export class Parameter { - private readonly transpiled: TranspiledParameter; + private readonly transpiledParam: TranspiledParameter; + private readonly transpiledCallable: TranspiledCallable; constructor( transpile: Transpile, private readonly parameter: reflect.Parameter, - private readonly linkFormatter: (type: TranspiledType) => string, ) { - this.transpiled = transpile.parameter(parameter); + this.transpiledParam = transpile.parameter(parameter); + this.transpiledCallable = transpile.callable(parameter.method); } - public get id(): string { - return `${this.transpiled.parentType.fqn}.parameter.${this.transpiled.name}`; - } - - public get linkedName(): string { - const isRequired = !this.parameter.optional ? '*' : ''; - return `[${Markdown.pre(this.transpiled.name)}](#${anchorForId(this.id)})${isRequired}`; - } - - public get type(): string { - return this.transpiled.typeReference.toString({ - typeFormatter: (t) => `[${Markdown.pre(t.fqn)}](${this.linkFormatter(t)})`, - stringFormatter: Markdown.pre, - }); - } - - public get description(): string { - const summary = this.parameter.docs.summary; - return summary.length > 0 ? summary : Markdown.italic('No description.'); - } - - public render(): Markdown { - const optionality = this.parameter.optional ? 'Optional' : 'Required'; - - const md = new Markdown({ - id: this.id, - header: { - title: this.transpiled.name, - sup: optionality, - pre: true, - strike: this.parameter.docs.deprecated, - }, - }); - - if (this.parameter.docs.deprecated) { - md.bullet( - `${Markdown.italic('Deprecated:')} ${ - this.parameter.docs.deprecationReason - }`, - ); - md.lines(''); - } - - const metadata: any = { Type: this.type }; - - if (this.parameter.spec.docs?.default) { - metadata.Default = Markdown.sanitize(this.parameter.spec.docs?.default); - } - - for (const [key, value] of Object.entries(metadata)) { - md.bullet(`${Markdown.italic(`${key}:`)} ${value}`); - } - md.lines(''); - - if (this.parameter.docs) { - md.docs(this.parameter.docs); - } - - md.split(); - - return md; + public toJson(): ParameterSchema { + const isInitializer = this.parameter.method.kind === reflect.MemberKind.Initializer; + const methodName = isInitializer ? 'Initializer' : this.transpiledCallable.name; + const methodId = isInitializer ? 'Initializer' : this.parameter.method.name; + return { + fqn: `${this.transpiledParam.parentType.fqn}.${methodName}.parameter.${this.transpiledParam.name}`, + displayName: this.transpiledParam.name, + id: `${this.parameter.parentType.fqn}.${methodId}.parameter.${this.parameter.name}`, + optional: this.transpiledParam.optional === true ? true : undefined, // to save space + default: this.parameter.spec.docs?.default, + type: this.transpiledParam.typeReference.toJson(), + docs: extractDocs(this.parameter.docs), + }; } } diff --git a/src/docgen/view/properties.ts b/src/docgen/view/properties.ts index dbef906e..d9927b25 100644 --- a/src/docgen/view/properties.ts +++ b/src/docgen/view/properties.ts @@ -1,33 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { PropertySchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Property } from './property'; export class Properties { private readonly properties: Property[]; - constructor(transpile: Transpile, properties: reflect.Property[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, properties: reflect.Property[]) { this.properties = properties .filter((p) => !p.protected && !p.const) - .map((p) => new Property(transpile, p, linkFormatter)); + .map((p) => new Property(transpile, p)); } - public render(): Markdown { - if (this.properties.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Properties' } }); - - md.table([ - ['Name', 'Type', 'Description'].map(Markdown.bold), - ...this.properties.map((prop) => [prop.linkedName, prop.type, Markdown.sanitize(prop.description)]), - ]); - md.split(); - - for (const property of this.properties) { - md.section(property.render()); - } - - return md; + public toJson(): PropertySchema[] { + return this.properties.map((p) => p.toJson()); } } diff --git a/src/docgen/view/property.ts b/src/docgen/view/property.ts index efa09dbf..dab2c39e 100644 --- a/src/docgen/view/property.ts +++ b/src/docgen/view/property.ts @@ -1,85 +1,26 @@ import * as reflect from 'jsii-reflect'; -import { anchorForId, Markdown } from '../render/markdown'; -import { Transpile, TranspiledProperty, TranspiledType } from '../transpile/transpile'; +import { extractDocs, PropertySchema } from '../schema'; +import { Transpile, TranspiledProperty } from '../transpile/transpile'; export class Property { private readonly transpiled: TranspiledProperty; constructor( - private readonly transpile: Transpile, + transpile: Transpile, private readonly property: reflect.Property, - private readonly linkFormatter: (type: TranspiledType) => string, ) { this.transpiled = transpile.property(property); } - public get id(): string { - return `${this.transpiled.parentType.fqn}.property.${this.transpiled.name}`; - } - - public get linkedName(): string { - const isRequired = !this.property.optional ? '*' : ''; - return `[${Markdown.pre(this.transpiled.name)}](#${anchorForId(this.id)})${isRequired}`; - } - - public get type(): string { - return this.transpiled.typeReference.toString({ - typeFormatter: (t) => `[${Markdown.pre(t.fqn)}](${this.linkFormatter(t)})`, - stringFormatter: Markdown.pre, - }); - } - - public get description(): string { - const summary = this.property.docs.summary; - return summary.length > 0 ? summary : Markdown.italic('No description.'); - } - - public render(): Markdown { - const optionality = this.property.const - ? undefined - : this.property.optional - ? 'Optional' - : 'Required'; - - const md = new Markdown({ - id: this.id, - header: { - title: this.transpiled.name, - sup: optionality, - pre: true, - strike: this.property.docs.deprecated, - }, - }); - - if (this.property.docs.deprecated) { - md.bullet( - `${Markdown.italic('Deprecated:')} ${ - this.property.docs.deprecationReason - }`, - ); - md.lines(''); - } - - if (!this.property.const) { - md.code(this.transpile.language.toString(), this.transpiled.declaration); - } - - const metadata: Record = { Type: this.type }; - - if (this.property.spec.docs?.default) { - metadata.Default = Markdown.sanitize(this.property.spec.docs?.default); - } - - for (const [key, value] of Object.entries(metadata)) { - md.bullet(`${Markdown.italic(`${key}:`)} ${value}`); - } - md.lines(''); - - if (this.property.docs) { - md.docs(this.property.docs); - } - - md.split(); - - return md; + public toJson(): PropertySchema { + return { + fqn: `${this.transpiled.parentType.fqn}.property.${this.transpiled.name}`, + displayName: this.transpiled.name, + id: `${this.property.parentType.fqn}.property.${this.property.name}`, + optional: this.transpiled.optional === true ? true : undefined, // to save space + default: this.property.spec.docs?.default, + type: this.transpiled.typeReference.toJson(), + docs: extractDocs(this.property.docs), + usage: this.transpiled.declaration, + }; } } diff --git a/src/docgen/view/readme.ts b/src/docgen/view/readme.ts index d8969e19..8553e977 100644 --- a/src/docgen/view/readme.ts +++ b/src/docgen/view/readme.ts @@ -1,5 +1,5 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; +import { MarkdownDocument } from '../render/markdown-doc'; import { Transpile } from '../transpile/transpile'; /** @@ -20,12 +20,12 @@ export class Readme { /** * Generate markdown. */ - public render(): Markdown { + public render(): MarkdownDocument { if (!this.readme) { - return Markdown.EMPTY; + return MarkdownDocument.EMPTY; } - const md = new Markdown(); + const md = new MarkdownDocument(); if (this.readme) { md.lines(this.readme); } diff --git a/src/docgen/view/static-function.ts b/src/docgen/view/static-function.ts index 3a145738..db27de29 100644 --- a/src/docgen/view/static-function.ts +++ b/src/docgen/view/static-function.ts @@ -1,6 +1,6 @@ import * as reflect from 'jsii-reflect'; -import { anchorForId, Markdown } from '../render/markdown'; -import { Transpile, TranspiledCallable, TranspiledType } from '../transpile/transpile'; +import { extractDocs, MethodSchema } from '../schema'; +import { Transpile, TranspiledCallable } from '../transpile/transpile'; import { Parameter } from './parameter'; export class StaticFunction { @@ -9,48 +9,21 @@ export class StaticFunction { constructor( private readonly transpile: Transpile, private readonly method: reflect.Method, - linkFormatter: (type: TranspiledType) => string, ) { this.transpiled = transpile.callable(method); this.parameters = this.transpiled.parameters.map( - (p) => new Parameter(this.transpile, p, linkFormatter), + (p) => new Parameter(this.transpile, p), ); } - public get id(): string { - return `${this.transpiled.parentType.fqn}.${this.transpiled.name}`; - } - - public get linkedName(): string { - return `[${Markdown.pre(this.transpiled.name)}](#${anchorForId(this.id)})`; - } - - public get description(): string { - const summary = this.method.docs.summary; - return summary.length > 0 ? summary : Markdown.italic('No description.'); - } - - public render(): Markdown { - const md = new Markdown({ - id: this.id, - header: { - title: this.transpiled.name, - pre: true, - strike: this.method.docs.deprecated, - }, - }); - - md.code( - this.transpile.language.toString(), - `${this.transpiled.import}`, - '', - ...this.transpiled.invocations, - ); - - for (const parameter of this.parameters) { - md.section(parameter.render()); - } - - return md; + public toJson(): MethodSchema { + return { + fqn: `${this.transpiled.parentType.fqn}.${this.transpiled.name}`, + displayName: this.transpiled.name, + id: `${this.method.parentType.fqn}.${this.method.name}`, + parameters: this.parameters.map((param) => param.toJson()), + docs: extractDocs(this.method.docs), + usage: `${this.transpiled.import}\n\n${this.transpiled.invocations}`, + }; } } diff --git a/src/docgen/view/static-functions.ts b/src/docgen/view/static-functions.ts index 9cda92e4..46434829 100644 --- a/src/docgen/view/static-functions.ts +++ b/src/docgen/view/static-functions.ts @@ -1,32 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { MethodSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { StaticFunction } from './static-function'; export class StaticFunctions { private readonly staticFunctions: StaticFunction[]; - constructor(transpile: Transpile, methods: reflect.Method[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, methods: reflect.Method[]) { this.staticFunctions = methods .filter((m) => !m.protected && m.static) - .map((m) => new StaticFunction(transpile, m, linkFormatter)); + .map((m) => new StaticFunction(transpile, m)); } - public render(): Markdown { - if (this.staticFunctions.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Static Functions' } }); - - md.table([ - ['Name', 'Description'].map(Markdown.bold), - ...this.staticFunctions.map((func) => [func.linkedName, Markdown.sanitize(func.description)]), - ]); - md.split(); - - for (const func of this.staticFunctions) { - md.section(func.render()); - } - return md; + public toJson(): MethodSchema[] { + return this.staticFunctions.map((method) => method.toJson()); } } diff --git a/src/docgen/view/struct.ts b/src/docgen/view/struct.ts index 32a70f83..1be688d4 100644 --- a/src/docgen/view/struct.ts +++ b/src/docgen/view/struct.ts @@ -1,44 +1,27 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledStruct, TranspiledType } from '../transpile/transpile'; +import { extractDocs, StructSchema } from '../schema'; +import { Transpile, TranspiledStruct } from '../transpile/transpile'; import { Properties } from './properties'; export class Struct { private readonly transpiled: TranspiledStruct; private readonly properties: Properties; constructor( - private readonly transpile: Transpile, + transpile: Transpile, private readonly iface: reflect.InterfaceType, - linkFormatter: (type: TranspiledType) => string, ) { this.transpiled = transpile.struct(iface); - this.properties = new Properties(transpile, this.iface.allProperties, linkFormatter); + this.properties = new Properties(transpile, this.iface.allProperties); } - public render(): Markdown { - const md = new Markdown({ - id: this.transpiled.type.fqn, - header: { title: this.transpiled.name }, - }); - - if (this.iface.docs) { - md.docs(this.iface.docs); - } - - const initializer = new Markdown({ - id: `${this.transpiled.type}.Initializer`, - header: { title: 'Initializer' }, - }); - - initializer.code( - this.transpile.language.toString(), - `${this.transpiled.import}`, - '', - `${this.transpiled.initialization}`, - ); - - md.section(initializer); - md.section(this.properties.render()); - return md; + public toJson(): StructSchema { + return { + fqn: this.transpiled.type.fqn, + displayName: this.transpiled.type.fqn.split('.').pop()!, + id: this.iface.fqn, + properties: this.properties.toJson(), + docs: extractDocs(this.iface.docs), + usage: `${this.transpiled.import}\n\n${this.transpiled.initialization}`, + }; } } diff --git a/src/docgen/view/structs.ts b/src/docgen/view/structs.ts index fbae5412..aacd7776 100644 --- a/src/docgen/view/structs.ts +++ b/src/docgen/view/structs.ts @@ -1,26 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { Markdown } from '../render/markdown'; -import { Transpile, TranspiledType } from '../transpile/transpile'; +import { StructSchema } from '../schema'; +import { Transpile } from '../transpile/transpile'; import { Interface } from './interface'; import { Struct } from './struct'; export class Structs { private readonly structs: Struct[]; - constructor(transpile: Transpile, interfaces: reflect.InterfaceType[], linkFormatter: (type: TranspiledType) => string) { + constructor(transpile: Transpile, interfaces: reflect.InterfaceType[]) { this.structs = interfaces .filter((i) => Interface.isStruct(i)) - .map((i) => new Struct(transpile, i, linkFormatter)); + .map((i) => new Struct(transpile, i)); } - public render(): Markdown { - if (this.structs.length === 0) { - return Markdown.EMPTY; - } - - const md = new Markdown({ header: { title: 'Structs' } }); - for (const struct of this.structs) { - md.section(struct.render()); - } - return md; + public toJson(): StructSchema[] { + return this.structs.map((s) => s.toJson()); } } diff --git a/src/index.ts b/src/index.ts index 95fb4233..a819fe2f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,6 @@ export { Documentation } from './docgen/view/documentation'; export { Language } from './docgen/transpile/transpile'; export { UnsupportedLanguageError } from './docgen/transpile/transpile'; -export { TranspiledType } from './docgen/transpile/transpile'; +export { MarkdownDocument } from './docgen/render/markdown-doc'; export * from './errors'; +export * from './docgen/schema'; diff --git a/test/__snapshots__/cli.test.ts.snap b/test/__snapshots__/cli.test.ts.snap index 598e4115..a6795321 100644 --- a/test/__snapshots__/cli.test.ts.snap +++ b/test/__snapshots__/cli.test.ts.snap @@ -3,11 +3,11 @@ exports[`construct-library 1`] = ` "# API Reference -## Constructs +## Constructs -### GreeterBucket +### GreeterBucket -#### Initializers +#### Initializers \`\`\`typescript import { GreeterBucket } from 'construct-library' @@ -17,39 +17,39 @@ new GreeterBucket(scope: Construct, id: string, props?: BucketProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#constructlibrarygreeterbucketparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#constructlibrarygreeterbucketparameterid)* | \`string\` | *No description.* | -| [\`props\`](#constructlibrarygreeterbucketparameterprops) | [\`@aws-cdk/aws-s3.BucketProps\`](#@aws-cdk/aws-s3.BucketProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | @aws-cdk/aws-s3.BucketProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-s3.BucketProps\`](#@aws-cdk/aws-s3.BucketProps) +- *Type:* @aws-cdk/aws-s3.BucketProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`greet\`](#constructlibrarygreeterbucketgreet) | *No description.* | +| greet | *No description.* | --- -##### \`greet\` +##### \`greet\` \`\`\`typescript public greet() @@ -67,11 +67,11 @@ public greet() exports[`specify language 1`] = ` "# API Reference -## Constructs +## Constructs -### GreeterBucket +### GreeterBucket -#### Initializers +#### Initializers \`\`\`python import construct_library @@ -106,57 +106,57 @@ construct_library.GreeterBucket( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#constructlibrarygreeterbucketparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#constructlibrarygreeterbucketparameterid)* | \`str\` | *No description.* | -| [\`access_control\`](#awscdkawss3bucketpropsparameteraccesscontrol) | [\`aws_cdk.aws_s3.BucketAccessControl\`](#aws_cdk.aws_s3.BucketAccessControl) | Specifies a canned ACL that grants predefined permissions to the bucket. | -| [\`auto_delete_objects\`](#awscdkawss3bucketpropsparameterautodeleteobjects) | \`bool\` | Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. | -| [\`block_public_access\`](#awscdkawss3bucketpropsparameterblockpublicaccess) | [\`aws_cdk.aws_s3.BlockPublicAccess\`](#aws_cdk.aws_s3.BlockPublicAccess) | The block public access configuration of this bucket. | -| [\`bucket_key_enabled\`](#awscdkawss3bucketpropsparameterbucketkeyenabled) | \`bool\` | Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. | -| [\`bucket_name\`](#awscdkawss3bucketpropsparameterbucketname) | \`str\` | Physical name of this bucket. | -| [\`cors\`](#awscdkawss3bucketpropsparametercors) | typing.List[[\`aws_cdk.aws_s3.CorsRule\`](#aws_cdk.aws_s3.CorsRule)] | The CORS configuration of this bucket. | -| [\`encryption\`](#awscdkawss3bucketpropsparameterencryption) | [\`aws_cdk.aws_s3.BucketEncryption\`](#aws_cdk.aws_s3.BucketEncryption) | The kind of server-side encryption to apply to this bucket. | -| [\`encryption_key\`](#awscdkawss3bucketpropsparameterencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | External KMS key to use for bucket encryption. | -| [\`enforce_ss_l\`](#awscdkawss3bucketpropsparameterenforcessl) | \`bool\` | Enforces SSL for requests. | -| [\`inventories\`](#awscdkawss3bucketpropsparameterinventories) | typing.List[[\`aws_cdk.aws_s3.Inventory\`](#aws_cdk.aws_s3.Inventory)] | The inventory configuration of the bucket. | -| [\`lifecycle_rules\`](#awscdkawss3bucketpropsparameterlifecyclerules) | typing.List[[\`aws_cdk.aws_s3.LifecycleRule\`](#aws_cdk.aws_s3.LifecycleRule)] | Rules that define how Amazon S3 manages objects during their lifetime. | -| [\`metrics\`](#awscdkawss3bucketpropsparametermetrics) | typing.List[[\`aws_cdk.aws_s3.BucketMetrics\`](#aws_cdk.aws_s3.BucketMetrics)] | The metrics configuration of this bucket. | -| [\`object_ownership\`](#awscdkawss3bucketpropsparameterobjectownership) | [\`aws_cdk.aws_s3.ObjectOwnership\`](#aws_cdk.aws_s3.ObjectOwnership) | The objectOwnership of the bucket. | -| [\`public_read_access\`](#awscdkawss3bucketpropsparameterpublicreadaccess) | \`bool\` | Grants public read access to all objects in the bucket. | -| [\`removal_policy\`](#awscdkawss3bucketpropsparameterremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) | Policy to apply when the bucket is removed from this stack. | -| [\`server_access_logs_bucket\`](#awscdkawss3bucketpropsparameterserveraccesslogsbucket) | [\`aws_cdk.aws_s3.IBucket\`](#aws_cdk.aws_s3.IBucket) | Destination bucket for the server access logs. | -| [\`server_access_logs_prefix\`](#awscdkawss3bucketpropsparameterserveraccesslogsprefix) | \`str\` | Optional log file prefix to use for the bucket's access logs. | -| [\`versioned\`](#awscdkawss3bucketpropsparameterversioned) | \`bool\` | Whether this bucket should have versioning turned on or not. | -| [\`website_error_document\`](#awscdkawss3bucketpropsparameterwebsiteerrordocument) | \`str\` | The name of the error document (e.g. \\"404.html\\") for the website. \`websiteIndexDocument\` must also be set if this is set. | -| [\`website_index_document\`](#awscdkawss3bucketpropsparameterwebsiteindexdocument) | \`str\` | The name of the index document (e.g. \\"index.html\\") for the website. Enables static website hosting for this bucket. | -| [\`website_redirect\`](#awscdkawss3bucketpropsparameterwebsiteredirect) | [\`aws_cdk.aws_s3.RedirectTarget\`](#aws_cdk.aws_s3.RedirectTarget) | Specifies the redirect behavior of all requests to a website endpoint of a bucket. | -| [\`website_routing_rules\`](#awscdkawss3bucketpropsparameterwebsiteroutingrules) | typing.List[[\`aws_cdk.aws_s3.RoutingRule\`](#aws_cdk.aws_s3.RoutingRule)] | Rules that define when a redirect is applied and the redirect behavior. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| access_control | aws_cdk.aws_s3.BucketAccessControl | Specifies a canned ACL that grants predefined permissions to the bucket. | +| auto_delete_objects | bool | Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. | +| block_public_access | aws_cdk.aws_s3.BlockPublicAccess | The block public access configuration of this bucket. | +| bucket_key_enabled | bool | Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. | +| bucket_name | str | Physical name of this bucket. | +| cors | typing.List[aws_cdk.aws_s3.CorsRule] | The CORS configuration of this bucket. | +| encryption | aws_cdk.aws_s3.BucketEncryption | The kind of server-side encryption to apply to this bucket. | +| encryption_key | aws_cdk.aws_kms.IKey | External KMS key to use for bucket encryption. | +| enforce_ss_l | bool | Enforces SSL for requests. | +| inventories | typing.List[aws_cdk.aws_s3.Inventory] | The inventory configuration of the bucket. | +| lifecycle_rules | typing.List[aws_cdk.aws_s3.LifecycleRule] | Rules that define how Amazon S3 manages objects during their lifetime. | +| metrics | typing.List[aws_cdk.aws_s3.BucketMetrics] | The metrics configuration of this bucket. | +| object_ownership | aws_cdk.aws_s3.ObjectOwnership | The objectOwnership of the bucket. | +| public_read_access | bool | Grants public read access to all objects in the bucket. | +| removal_policy | aws_cdk.core.RemovalPolicy | Policy to apply when the bucket is removed from this stack. | +| server_access_logs_bucket | aws_cdk.aws_s3.IBucket | Destination bucket for the server access logs. | +| server_access_logs_prefix | str | Optional log file prefix to use for the bucket's access logs. | +| versioned | bool | Whether this bucket should have versioning turned on or not. | +| website_error_document | str | The name of the error document (e.g. \\"404.html\\") for the website. \`websiteIndexDocument\` must also be set if this is set. | +| website_index_document | str | The name of the index document (e.g. \\"index.html\\") for the website. Enables static website hosting for this bucket. | +| website_redirect | aws_cdk.aws_s3.RedirectTarget | Specifies the redirect behavior of all requests to a website endpoint of a bucket. | +| website_routing_rules | typing.List[aws_cdk.aws_s3.RoutingRule] | Rules that define when a redirect is applied and the redirect behavior. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`access_control\`Optional +##### \`access_control\`Optional -- *Type:* [\`aws_cdk.aws_s3.BucketAccessControl\`](#aws_cdk.aws_s3.BucketAccessControl) +- *Type:* aws_cdk.aws_s3.BucketAccessControl - *Default:* BucketAccessControl.PRIVATE Specifies a canned ACL that grants predefined permissions to the bucket. --- -##### \`auto_delete_objects\`Optional +##### \`auto_delete_objects\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether all objects should be automatically deleted when the bucket is removed from the stack or when the stack is deleted. @@ -165,20 +165,20 @@ Requires the \`removalPolicy\` to be set to \`RemovalPolicy.DESTROY\`. **Warnin --- -##### \`block_public_access\`Optional +##### \`block_public_access\`Optional -- *Type:* [\`aws_cdk.aws_s3.BlockPublicAccess\`](#aws_cdk.aws_s3.BlockPublicAccess) +- *Type:* aws_cdk.aws_s3.BlockPublicAccess - *Default:* CloudFormation defaults will apply. New buckets and objects don't allow public access, but users can modify bucket policies or object permissions to allow public access The block public access configuration of this bucket. -> https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html +> [https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) --- -##### \`bucket_key_enabled\`Optional +##### \`bucket_key_enabled\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. @@ -187,29 +187,29 @@ Only relevant, when Encryption is set to {@link BucketEncryption.KMS} --- -##### \`bucket_name\`Optional +##### \`bucket_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Assigned by CloudFormation (recommended). Physical name of this bucket. --- -##### \`cors\`Optional +##### \`cors\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_s3.CorsRule\`](#aws_cdk.aws_s3.CorsRule)] +- *Type:* typing.List[aws_cdk.aws_s3.CorsRule] - *Default:* No CORS configuration. The CORS configuration of this bucket. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html) --- -##### \`encryption\`Optional +##### \`encryption\`Optional -- *Type:* [\`aws_cdk.aws_s3.BucketEncryption\`](#aws_cdk.aws_s3.BucketEncryption) +- *Type:* aws_cdk.aws_s3.BucketEncryption - *Default:* \`Kms\` if \`encryptionKey\` is specified, or \`Unencrypted\` otherwise. The kind of server-side encryption to apply to this bucket. @@ -218,9 +218,9 @@ If you choose KMS, you can specify a KMS key via \`encryptionKey\`. If encryptio --- -##### \`encryption_key\`Optional +##### \`encryption_key\`Optional -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* If encryption is set to \\"Kms\\" and this property is undefined, a new KMS key will be created and associated with this bucket. External KMS key to use for bucket encryption. @@ -229,64 +229,64 @@ The 'encryption' property must be either not specified or set to \\"Kms\\". An e --- -##### \`enforce_ss_l\`Optional +##### \`enforce_ss_l\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enforces SSL for requests. S3.5 of the AWS Foundational Security Best Practices Regarding S3. -> https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html +> [https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-ssl-requests-only.html) --- -##### \`inventories\`Optional +##### \`inventories\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_s3.Inventory\`](#aws_cdk.aws_s3.Inventory)] +- *Type:* typing.List[aws_cdk.aws_s3.Inventory] - *Default:* No inventory configuration The inventory configuration of the bucket. -> https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html +> [https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycle_rules\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_s3.LifecycleRule\`](#aws_cdk.aws_s3.LifecycleRule)] +- *Type:* typing.List[aws_cdk.aws_s3.LifecycleRule] - *Default:* No lifecycle rules. Rules that define how Amazon S3 manages objects during their lifetime. --- -##### \`metrics\`Optional +##### \`metrics\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_s3.BucketMetrics\`](#aws_cdk.aws_s3.BucketMetrics)] +- *Type:* typing.List[aws_cdk.aws_s3.BucketMetrics] - *Default:* No metrics configuration. The metrics configuration of this bucket. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html) --- -##### \`object_ownership\`Optional +##### \`object_ownership\`Optional -- *Type:* [\`aws_cdk.aws_s3.ObjectOwnership\`](#aws_cdk.aws_s3.ObjectOwnership) +- *Type:* aws_cdk.aws_s3.ObjectOwnership - *Default:* No ObjectOwnership configuration, uploading account will own the object. The objectOwnership of the bucket. -> https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html +> [https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html) --- -##### \`public_read_access\`Optional +##### \`public_read_access\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Grants public read access to all objects in the bucket. @@ -295,27 +295,27 @@ Similar to calling \`bucket.grantPublicAccess()\` --- -##### \`removal_policy\`Optional +##### \`removal_policy\`Optional -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) +- *Type:* aws_cdk.core.RemovalPolicy - *Default:* The bucket will be orphaned. Policy to apply when the bucket is removed from this stack. --- -##### \`server_access_logs_bucket\`Optional +##### \`server_access_logs_bucket\`Optional -- *Type:* [\`aws_cdk.aws_s3.IBucket\`](#aws_cdk.aws_s3.IBucket) +- *Type:* aws_cdk.aws_s3.IBucket - *Default:* If \\"serverAccessLogsPrefix\\" undefined - access logs disabled, otherwise - log to current bucket. Destination bucket for the server access logs. --- -##### \`server_access_logs_prefix\`Optional +##### \`server_access_logs_prefix\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No log file prefix Optional log file prefix to use for the bucket's access logs. @@ -324,36 +324,36 @@ If defined without \\"serverAccessLogsBucket\\", enables access logs to current --- -##### \`versioned\`Optional +##### \`versioned\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether this bucket should have versioning turned on or not. --- -##### \`website_error_document\`Optional +##### \`website_error_document\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No error document. The name of the error document (e.g. \\"404.html\\") for the website. \`websiteIndexDocument\` must also be set if this is set. --- -##### \`website_index_document\`Optional +##### \`website_index_document\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No index document. The name of the index document (e.g. \\"index.html\\") for the website. Enables static website hosting for this bucket. --- -##### \`website_redirect\`Optional +##### \`website_redirect\`Optional -- *Type:* [\`aws_cdk.aws_s3.RedirectTarget\`](#aws_cdk.aws_s3.RedirectTarget) +- *Type:* aws_cdk.aws_s3.RedirectTarget - *Default:* No redirection. Specifies the redirect behavior of all requests to a website endpoint of a bucket. @@ -362,24 +362,24 @@ If you specify this property, you can't specify \\"websiteIndexDocument\\", \\"w --- -##### \`website_routing_rules\`Optional +##### \`website_routing_rules\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_s3.RoutingRule\`](#aws_cdk.aws_s3.RoutingRule)] +- *Type:* typing.List[aws_cdk.aws_s3.RoutingRule] - *Default:* No redirection rules. Rules that define when a redirect is applied and the redirect behavior. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`greet\`](#constructlibrarygreeterbucketgreet) | *No description.* | +| greet | *No description.* | --- -##### \`greet\` +##### \`greet\` \`\`\`python def greet() diff --git a/test/docgen/transpile/__snapshots__/transpile.test.ts.snap b/test/docgen/transpile/__snapshots__/transpile.test.ts.snap index 8f2aa7a1..0e4c0c8f 100644 --- a/test/docgen/transpile/__snapshots__/transpile.test.ts.snap +++ b/test/docgen/transpile/__snapshots__/transpile.test.ts.snap @@ -1,20 +1,19 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`submodules without an explicit name csharp 1`] = ` -" -# API Reference +"# API Reference -## Constructs +## Constructs -### EdgeFunction +### EdgeFunction -- *Implements:* [\`Amazon.CDK.AWS.Lambda.IVersion\`](#Amazon.CDK.AWS.Lambda.IVersion) +- *Implements:* Amazon.CDK.AWS.Lambda.IVersion A Lambda@Edge function. Convenience resource for requesting a Lambda function in the 'us-east-1' region for use with Lambda@Edge. Implements several restrictions enforced by Lambda@Edge. Note that this construct requires that the 'us-east-1' region has been bootstrapped. See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html or 'cdk bootstrap --help' for options. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.CloudFront; @@ -24,244 +23,244 @@ new EdgeFunction(Construct Scope, string Id, EdgeFunctionProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawscloudfrontexperimentaledgefunctionparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawscloudfrontexperimentaledgefunctionparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawscloudfrontexperimentaledgefunctionparameterprops)* | [\`Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps\`](#Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps\`](#Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps) +- *Type:* Amazon.CDK.AWS.CloudFront.experimental.EdgeFunctionProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddAlias\`](#amazoncdkawscloudfrontexperimentaledgefunctionaddalias) | Defines an alias for this version. | -| [\`AddEventSource\`](#amazoncdkawscloudfrontexperimentaledgefunctionaddeventsource) | Adds an event source to this function. | -| [\`AddEventSourceMapping\`](#amazoncdkawscloudfrontexperimentaledgefunctionaddeventsourcemapping) | Adds an event source that maps to this AWS Lambda function. | -| [\`AddPermission\`](#amazoncdkawscloudfrontexperimentaledgefunctionaddpermission) | Adds a permission to the Lambda resource policy. | -| [\`AddToRolePolicy\`](#amazoncdkawscloudfrontexperimentaledgefunctionaddtorolepolicy) | Adds a statement to the IAM role assumed by the instance. | -| [\`ConfigureAsyncInvoke\`](#amazoncdkawscloudfrontexperimentaledgefunctionconfigureasyncinvoke) | Configures options for asynchronous invocation. | -| [\`GrantInvoke\`](#amazoncdkawscloudfrontexperimentaledgefunctiongrantinvoke) | Grant the given identity permissions to invoke this Lambda. | -| [\`Metric\`](#amazoncdkawscloudfrontexperimentaledgefunctionmetric) | Return the given named metric for this Lambda Return the given named metric for this Function. | -| [\`MetricDuration\`](#amazoncdkawscloudfrontexperimentaledgefunctionmetricduration) | Metric for the Duration of this Lambda How long execution of this Lambda takes. | -| [\`MetricErrors\`](#amazoncdkawscloudfrontexperimentaledgefunctionmetricerrors) | How many invocations of this Lambda fail. | -| [\`MetricInvocations\`](#amazoncdkawscloudfrontexperimentaledgefunctionmetricinvocations) | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | -| [\`MetricThrottles\`](#amazoncdkawscloudfrontexperimentaledgefunctionmetricthrottles) | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | +| AddAlias | Defines an alias for this version. | +| AddEventSource | Adds an event source to this function. | +| AddEventSourceMapping | Adds an event source that maps to this AWS Lambda function. | +| AddPermission | Adds a permission to the Lambda resource policy. | +| AddToRolePolicy | Adds a statement to the IAM role assumed by the instance. | +| ConfigureAsyncInvoke | Configures options for asynchronous invocation. | +| GrantInvoke | Grant the given identity permissions to invoke this Lambda. | +| Metric | Return the given named metric for this Lambda Return the given named metric for this Function. | +| MetricDuration | Metric for the Duration of this Lambda How long execution of this Lambda takes. | +| MetricErrors | How many invocations of this Lambda fail. | +| MetricInvocations | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | +| MetricThrottles | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | --- -##### \`AddAlias\` +##### \`AddAlias\` \`\`\`csharp private AddAlias(string AliasName, AliasOptions Options = null) \`\`\` -###### \`AliasName\`Required +###### \`AliasName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Lambda.AliasOptions\`](#Amazon.CDK.AWS.Lambda.AliasOptions) +- *Type:* Amazon.CDK.AWS.Lambda.AliasOptions --- -##### \`AddEventSource\` +##### \`AddEventSource\` \`\`\`csharp private AddEventSource(IEventSource Source) \`\`\` -###### \`Source\`Required +###### \`Source\`Required -- *Type:* [\`Amazon.CDK.AWS.Lambda.IEventSource\`](#Amazon.CDK.AWS.Lambda.IEventSource) +- *Type:* Amazon.CDK.AWS.Lambda.IEventSource --- -##### \`AddEventSourceMapping\` +##### \`AddEventSourceMapping\` \`\`\`csharp private AddEventSourceMapping(string Id, EventSourceMappingOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.AWS.Lambda.EventSourceMappingOptions\`](#Amazon.CDK.AWS.Lambda.EventSourceMappingOptions) +- *Type:* Amazon.CDK.AWS.Lambda.EventSourceMappingOptions --- -##### \`AddPermission\` +##### \`AddPermission\` \`\`\`csharp private AddPermission(string Id, Permission Permission) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Permission\`Required +###### \`Permission\`Required -- *Type:* [\`Amazon.CDK.AWS.Lambda.Permission\`](#Amazon.CDK.AWS.Lambda.Permission) +- *Type:* Amazon.CDK.AWS.Lambda.Permission --- -##### \`AddToRolePolicy\` +##### \`AddToRolePolicy\` \`\`\`csharp private AddToRolePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -##### \`ConfigureAsyncInvoke\` +##### \`ConfigureAsyncInvoke\` \`\`\`csharp private ConfigureAsyncInvoke(EventInvokeConfigOptions Options) \`\`\` -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.AWS.Lambda.EventInvokeConfigOptions\`](#Amazon.CDK.AWS.Lambda.EventInvokeConfigOptions) +- *Type:* Amazon.CDK.AWS.Lambda.EventInvokeConfigOptions --- -##### \`GrantInvoke\` +##### \`GrantInvoke\` \`\`\`csharp private GrantInvoke(IGrantable Identity) \`\`\` -###### \`Identity\`Required +###### \`Identity\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`Metric\` +##### \`Metric\` \`\`\`csharp private Metric(string MetricName, MetricOptions Props = null) \`\`\` -###### \`MetricName\`Required +###### \`MetricName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Props\`Optional +###### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.CloudWatch.MetricOptions\`](#Amazon.CDK.AWS.CloudWatch.MetricOptions) +- *Type:* Amazon.CDK.AWS.CloudWatch.MetricOptions --- -##### \`MetricDuration\` +##### \`MetricDuration\` \`\`\`csharp private MetricDuration(MetricOptions Props = null) \`\`\` -###### \`Props\`Optional +###### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.CloudWatch.MetricOptions\`](#Amazon.CDK.AWS.CloudWatch.MetricOptions) +- *Type:* Amazon.CDK.AWS.CloudWatch.MetricOptions --- -##### \`MetricErrors\` +##### \`MetricErrors\` \`\`\`csharp private MetricErrors(MetricOptions Props = null) \`\`\` -###### \`Props\`Optional +###### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.CloudWatch.MetricOptions\`](#Amazon.CDK.AWS.CloudWatch.MetricOptions) +- *Type:* Amazon.CDK.AWS.CloudWatch.MetricOptions --- -##### \`MetricInvocations\` +##### \`MetricInvocations\` \`\`\`csharp private MetricInvocations(MetricOptions Props = null) \`\`\` -###### \`Props\`Optional +###### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.CloudWatch.MetricOptions\`](#Amazon.CDK.AWS.CloudWatch.MetricOptions) +- *Type:* Amazon.CDK.AWS.CloudWatch.MetricOptions --- -##### \`MetricThrottles\` +##### \`MetricThrottles\` \`\`\`csharp private MetricThrottles(MetricOptions Props = null) \`\`\` -###### \`Props\`Optional +###### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.CloudWatch.MetricOptions\`](#Amazon.CDK.AWS.CloudWatch.MetricOptions) +- *Type:* Amazon.CDK.AWS.CloudWatch.MetricOptions --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Connections\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyconnections)* | [\`Amazon.CDK.AWS.EC2.Connections\`](#Amazon.CDK.AWS.EC2.Connections) | Not supported. | -| [\`CurrentVersion\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertycurrentversion)* | [\`Amazon.CDK.AWS.Lambda.IVersion\`](#Amazon.CDK.AWS.Lambda.IVersion) | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | -| [\`EdgeArn\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyedgearn)* | \`string\` | The ARN of the version for Lambda@Edge. | -| [\`FunctionArn\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyfunctionarn)* | \`string\` | The ARN of the function. | -| [\`FunctionName\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyfunctionname)* | \`string\` | The name of the function. | -| [\`GrantPrincipal\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertygrantprincipal)* | [\`Amazon.CDK.AWS.IAM.IPrincipal\`](#Amazon.CDK.AWS.IAM.IPrincipal) | The principal to grant permissions to. | -| [\`IsBoundToVpc\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyisboundtovpc)* | \`bool\` | Whether or not this Lambda function was bound to a VPC. | -| [\`Lambda\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertylambda)* | [\`Amazon.CDK.AWS.Lambda.IFunction\`](#Amazon.CDK.AWS.Lambda.IFunction) | The underlying AWS Lambda function. | -| [\`LatestVersion\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertylatestversion)* | [\`Amazon.CDK.AWS.Lambda.IVersion\`](#Amazon.CDK.AWS.Lambda.IVersion) | The \`$LATEST\` version of this function. | -| [\`PermissionsNode\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertypermissionsnode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct node where permissions are attached. | -| [\`Version\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyversion)* | \`string\` | The most recently deployed version of this function. | -| [\`Role\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropertyrole) | [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) | The IAM role associated with this function. | +| Connections | Amazon.CDK.AWS.EC2.Connections | Not supported. | +| CurrentVersion | Amazon.CDK.AWS.Lambda.IVersion | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | +| EdgeArn | string | The ARN of the version for Lambda@Edge. | +| FunctionArn | string | The ARN of the function. | +| FunctionName | string | The name of the function. | +| GrantPrincipal | Amazon.CDK.AWS.IAM.IPrincipal | The principal to grant permissions to. | +| IsBoundToVpc | bool | Whether or not this Lambda function was bound to a VPC. | +| Lambda | Amazon.CDK.AWS.Lambda.IFunction | The underlying AWS Lambda function. | +| LatestVersion | Amazon.CDK.AWS.Lambda.IVersion | The \`$LATEST\` version of this function. | +| PermissionsNode | Amazon.CDK.ConstructNode | The construct node where permissions are attached. | +| Version | string | The most recently deployed version of this function. | +| Role | Amazon.CDK.AWS.IAM.IRole | The IAM role associated with this function. | --- -##### \`Connections\`Required +##### \`Connections\`Required \`\`\`csharp public Connections Connections { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.EC2.Connections\`](#Amazon.CDK.AWS.EC2.Connections) +- *Type:* Amazon.CDK.AWS.EC2.Connections Not supported. @@ -269,73 +268,73 @@ Connections are only applicable to VPC-enabled functions. --- -##### \`CurrentVersion\`Required +##### \`CurrentVersion\`Required \`\`\`csharp public IVersion CurrentVersion { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IVersion\`](#Amazon.CDK.AWS.Lambda.IVersion) +- *Type:* Amazon.CDK.AWS.Lambda.IVersion Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. --- -##### \`EdgeArn\`Required +##### \`EdgeArn\`Required \`\`\`csharp public string EdgeArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the version for Lambda@Edge. --- -##### \`FunctionArn\`Required +##### \`FunctionArn\`Required \`\`\`csharp public string FunctionArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the function. --- -##### \`FunctionName\`Required +##### \`FunctionName\`Required \`\`\`csharp public string FunctionName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the function. --- -##### \`GrantPrincipal\`Required +##### \`GrantPrincipal\`Required \`\`\`csharp public IPrincipal GrantPrincipal { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.IAM.IPrincipal\`](#Amazon.CDK.AWS.IAM.IPrincipal) +- *Type:* Amazon.CDK.AWS.IAM.IPrincipal The principal to grant permissions to. --- -##### \`IsBoundToVpc\`Required +##### \`IsBoundToVpc\`Required \`\`\`csharp public bool IsBoundToVpc { get; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool Whether or not this Lambda function was bound to a VPC. @@ -343,25 +342,25 @@ If this is is \`false\`, trying to access the \`connections\` object will fail. --- -##### \`Lambda\`Required +##### \`Lambda\`Required \`\`\`csharp public IFunction Lambda { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IFunction\`](#Amazon.CDK.AWS.Lambda.IFunction) +- *Type:* Amazon.CDK.AWS.Lambda.IFunction The underlying AWS Lambda function. --- -##### \`LatestVersion\`Required +##### \`LatestVersion\`Required \`\`\`csharp public IVersion LatestVersion { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IVersion\`](#Amazon.CDK.AWS.Lambda.IVersion) +- *Type:* Amazon.CDK.AWS.Lambda.IVersion The \`$LATEST\` version of this function. @@ -369,50 +368,50 @@ Note that this is reference to a non-specific AWS Lambda version, which means th --- -##### \`PermissionsNode\`Required +##### \`PermissionsNode\`Required \`\`\`csharp public ConstructNode PermissionsNode { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct node where permissions are attached. --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The most recently deployed version of this function. --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) +- *Type:* Amazon.CDK.AWS.IAM.IRole The IAM role associated with this function. --- -## Structs +## Structs -### EdgeFunctionProps +### EdgeFunctionProps Properties for creating a Lambda@Edge function. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.CloudFront; @@ -459,58 +458,58 @@ new EdgeFunctionProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`MaxEventAge\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertymaxeventage) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The maximum age of a request that Lambda sends to a function for processing. | -| [\`OnFailure\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyonfailure) | [\`Amazon.CDK.AWS.Lambda.IDestination\`](#Amazon.CDK.AWS.Lambda.IDestination) | The destination for failed invocations. | -| [\`OnSuccess\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyonsuccess) | [\`Amazon.CDK.AWS.Lambda.IDestination\`](#Amazon.CDK.AWS.Lambda.IDestination) | The destination for successful invocations. | -| [\`RetryAttempts\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyretryattempts) | \`double\` | The maximum number of times to retry when the function returns an error. | -| [\`AllowAllOutbound\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyallowalloutbound) | \`bool\` | Whether to allow the Lambda to send all network traffic. | -| [\`AllowPublicSubnet\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyallowpublicsubnet) | \`bool\` | Lambda Functions in a public subnet can NOT access the internet. | -| [\`Architectures\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyarchitectures) | [\`Amazon.CDK.AWS.Lambda.Architecture\`](#Amazon.CDK.AWS.Lambda.Architecture)[] | The system architectures compatible with this lambda function. | -| [\`CodeSigningConfig\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertycodesigningconfig) | [\`Amazon.CDK.AWS.Lambda.ICodeSigningConfig\`](#Amazon.CDK.AWS.Lambda.ICodeSigningConfig) | Code signing config associated with this function. | -| [\`CurrentVersionOptions\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertycurrentversionoptions) | [\`Amazon.CDK.AWS.Lambda.VersionOptions\`](#Amazon.CDK.AWS.Lambda.VersionOptions) | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | -| [\`DeadLetterQueue\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertydeadletterqueue) | [\`Amazon.CDK.AWS.SQS.IQueue\`](#Amazon.CDK.AWS.SQS.IQueue) | The SQS queue to use if DLQ is enabled. | -| [\`DeadLetterQueueEnabled\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertydeadletterqueueenabled) | \`bool\` | Enabled DLQ. | -| [\`Description\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertydescription) | \`string\` | A description of the function. | -| [\`Environment\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyenvironment) | System.Collections.Generic.IDictionary | Key-value pairs that Lambda caches and makes available for your Lambda functions. | -| [\`EnvironmentEncryption\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyenvironmentencryption) | [\`Amazon.CDK.AWS.KMS.IKey\`](#Amazon.CDK.AWS.KMS.IKey) | The AWS KMS key that's used to encrypt your function's environment variables. | -| [\`Events\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyevents) | [\`Amazon.CDK.AWS.Lambda.IEventSource\`](#Amazon.CDK.AWS.Lambda.IEventSource)[] | Event sources for this function. | -| [\`Filesystem\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyfilesystem) | [\`Amazon.CDK.AWS.Lambda.FileSystem\`](#Amazon.CDK.AWS.Lambda.FileSystem) | The filesystem configuration for the lambda function. | -| [\`FunctionName\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyfunctionname) | \`string\` | A name for the function. | -| [\`InitialPolicy\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyinitialpolicy) | [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement)[] | Initial policy statements to add to the created Lambda Role. | -| [\`InsightsVersion\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyinsightsversion) | [\`Amazon.CDK.AWS.Lambda.LambdaInsightsVersion\`](#Amazon.CDK.AWS.Lambda.LambdaInsightsVersion) | Specify the version of CloudWatch Lambda insights to use for monitoring. | -| [\`Layers\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertylayers) | [\`Amazon.CDK.AWS.Lambda.ILayerVersion\`](#Amazon.CDK.AWS.Lambda.ILayerVersion)[] | A list of layers to add to the function's execution environment. | -| [\`LogRetention\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertylogretention) | [\`Amazon.CDK.AWS.Logs.RetentionDays\`](#Amazon.CDK.AWS.Logs.RetentionDays) | The number of days log events are kept in CloudWatch Logs. | -| [\`LogRetentionRetryOptions\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertylogretentionretryoptions) | [\`Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions\`](#Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions) | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | -| [\`LogRetentionRole\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertylogretentionrole) | [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | -| [\`MemorySize\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertymemorysize) | \`double\` | The amount of memory, in MB, that is allocated to your Lambda function. | -| [\`Profiling\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyprofiling) | \`bool\` | Enable profiling. | -| [\`ProfilingGroup\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyprofilinggroup) | [\`Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup\`](#Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup) | Profiling Group. | -| [\`ReservedConcurrentExecutions\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyreservedconcurrentexecutions) | \`double\` | The maximum of concurrent executions you want to reserve for the function. | -| [\`Role\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyrole) | [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) | Lambda execution role. | -| [\`SecurityGroup\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertysecuritygroup) | [\`Amazon.CDK.AWS.EC2.ISecurityGroup\`](#Amazon.CDK.AWS.EC2.ISecurityGroup) | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | -| [\`SecurityGroups\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertysecuritygroups) | [\`Amazon.CDK.AWS.EC2.ISecurityGroup\`](#Amazon.CDK.AWS.EC2.ISecurityGroup)[] | The list of security groups to associate with the Lambda's network interfaces. | -| [\`Timeout\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The function execution time (in seconds) after which Lambda terminates the function. | -| [\`Tracing\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertytracing) | [\`Amazon.CDK.AWS.Lambda.Tracing\`](#Amazon.CDK.AWS.Lambda.Tracing) | Enable AWS X-Ray Tracing for Lambda Function. | -| [\`Vpc\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyvpc) | [\`Amazon.CDK.AWS.EC2.IVpc\`](#Amazon.CDK.AWS.EC2.IVpc) | VPC network to place Lambda network interfaces. | -| [\`VpcSubnets\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyvpcsubnets) | [\`Amazon.CDK.AWS.EC2.SubnetSelection\`](#Amazon.CDK.AWS.EC2.SubnetSelection) | Where to place the network interfaces within the VPC. | -| [\`Code\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertycode)* | [\`Amazon.CDK.AWS.Lambda.Code\`](#Amazon.CDK.AWS.Lambda.Code) | The source code of your Lambda function. | -| [\`Handler\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyhandler)* | \`string\` | The name of the method within your code that Lambda calls to execute your function. | -| [\`Runtime\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertyruntime)* | [\`Amazon.CDK.AWS.Lambda.Runtime\`](#Amazon.CDK.AWS.Lambda.Runtime) | The runtime environment for the Lambda function that you are uploading. | -| [\`StackId\`](#amazoncdkawscloudfrontexperimentaledgefunctionpropspropertystackid) | \`string\` | The stack ID of Lambda@Edge function. | - ---- - -##### \`MaxEventAge\`Optional +| MaxEventAge | Amazon.CDK.Duration | The maximum age of a request that Lambda sends to a function for processing. | +| OnFailure | Amazon.CDK.AWS.Lambda.IDestination | The destination for failed invocations. | +| OnSuccess | Amazon.CDK.AWS.Lambda.IDestination | The destination for successful invocations. | +| RetryAttempts | double | The maximum number of times to retry when the function returns an error. | +| AllowAllOutbound | bool | Whether to allow the Lambda to send all network traffic. | +| AllowPublicSubnet | bool | Lambda Functions in a public subnet can NOT access the internet. | +| Architectures | Amazon.CDK.AWS.Lambda.Architecture[] | The system architectures compatible with this lambda function. | +| CodeSigningConfig | Amazon.CDK.AWS.Lambda.ICodeSigningConfig | Code signing config associated with this function. | +| CurrentVersionOptions | Amazon.CDK.AWS.Lambda.VersionOptions | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | +| DeadLetterQueue | Amazon.CDK.AWS.SQS.IQueue | The SQS queue to use if DLQ is enabled. | +| DeadLetterQueueEnabled | bool | Enabled DLQ. | +| Description | string | A description of the function. | +| Environment | System.Collections.Generic.IDictionary | Key-value pairs that Lambda caches and makes available for your Lambda functions. | +| EnvironmentEncryption | Amazon.CDK.AWS.KMS.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | +| Events | Amazon.CDK.AWS.Lambda.IEventSource[] | Event sources for this function. | +| Filesystem | Amazon.CDK.AWS.Lambda.FileSystem | The filesystem configuration for the lambda function. | +| FunctionName | string | A name for the function. | +| InitialPolicy | Amazon.CDK.AWS.IAM.PolicyStatement[] | Initial policy statements to add to the created Lambda Role. | +| InsightsVersion | Amazon.CDK.AWS.Lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | +| Layers | Amazon.CDK.AWS.Lambda.ILayerVersion[] | A list of layers to add to the function's execution environment. | +| LogRetention | Amazon.CDK.AWS.Logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | +| LogRetentionRetryOptions | Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | +| LogRetentionRole | Amazon.CDK.AWS.IAM.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | +| MemorySize | double | The amount of memory, in MB, that is allocated to your Lambda function. | +| Profiling | bool | Enable profiling. | +| ProfilingGroup | Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup | Profiling Group. | +| ReservedConcurrentExecutions | double | The maximum of concurrent executions you want to reserve for the function. | +| Role | Amazon.CDK.AWS.IAM.IRole | Lambda execution role. | +| SecurityGroup | Amazon.CDK.AWS.EC2.ISecurityGroup | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | +| SecurityGroups | Amazon.CDK.AWS.EC2.ISecurityGroup[] | The list of security groups to associate with the Lambda's network interfaces. | +| Timeout | Amazon.CDK.Duration | The function execution time (in seconds) after which Lambda terminates the function. | +| Tracing | Amazon.CDK.AWS.Lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | +| Vpc | Amazon.CDK.AWS.EC2.IVpc | VPC network to place Lambda network interfaces. | +| VpcSubnets | Amazon.CDK.AWS.EC2.SubnetSelection | Where to place the network interfaces within the VPC. | +| Code | Amazon.CDK.AWS.Lambda.Code | The source code of your Lambda function. | +| Handler | string | The name of the method within your code that Lambda calls to execute your function. | +| Runtime | Amazon.CDK.AWS.Lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | +| StackId | string | The stack ID of Lambda@Edge function. | + +--- + +##### \`MaxEventAge\`Optional \`\`\`csharp public Duration MaxEventAge { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -519,39 +518,39 @@ Minimum: 60 seconds Maximum: 6 hours --- -##### \`OnFailure\`Optional +##### \`OnFailure\`Optional \`\`\`csharp public IDestination OnFailure { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IDestination\`](#Amazon.CDK.AWS.Lambda.IDestination) +- *Type:* Amazon.CDK.AWS.Lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -##### \`OnSuccess\`Optional +##### \`OnSuccess\`Optional \`\`\`csharp public IDestination OnSuccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IDestination\`](#Amazon.CDK.AWS.Lambda.IDestination) +- *Type:* Amazon.CDK.AWS.Lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -##### \`RetryAttempts\`Optional +##### \`RetryAttempts\`Optional \`\`\`csharp public double RetryAttempts { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -560,13 +559,13 @@ Minimum: 0 Maximum: 2 --- -##### \`AllowAllOutbound\`Optional +##### \`AllowAllOutbound\`Optional \`\`\`csharp public bool AllowAllOutbound { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether to allow the Lambda to send all network traffic. @@ -575,82 +574,82 @@ If set to false, you must individually add traffic rules to allow the Lambda to --- -##### \`AllowPublicSubnet\`Optional +##### \`AllowPublicSubnet\`Optional \`\`\`csharp public bool AllowPublicSubnet { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. -> https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841 +> [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- -##### \`Architectures\`Optional +##### \`Architectures\`Optional \`\`\`csharp public Architecture[] Architectures { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.Architecture\`](#Amazon.CDK.AWS.Lambda.Architecture)[] +- *Type:* Amazon.CDK.AWS.Lambda.Architecture[] - *Default:* [Architecture.X86_64] The system architectures compatible with this lambda function. --- -##### \`CodeSigningConfig\`Optional +##### \`CodeSigningConfig\`Optional \`\`\`csharp public ICodeSigningConfig CodeSigningConfig { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.ICodeSigningConfig\`](#Amazon.CDK.AWS.Lambda.ICodeSigningConfig) +- *Type:* Amazon.CDK.AWS.Lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- -##### \`CurrentVersionOptions\`Optional +##### \`CurrentVersionOptions\`Optional \`\`\`csharp public VersionOptions CurrentVersionOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.VersionOptions\`](#Amazon.CDK.AWS.Lambda.VersionOptions) +- *Type:* Amazon.CDK.AWS.Lambda.VersionOptions - *Default:* default options as described in \`VersionOptions\` Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. --- -##### \`DeadLetterQueue\`Optional +##### \`DeadLetterQueue\`Optional \`\`\`csharp public IQueue DeadLetterQueue { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.SQS.IQueue\`](#Amazon.CDK.AWS.SQS.IQueue) +- *Type:* Amazon.CDK.AWS.SQS.IQueue - *Default:* SQS queue with 14 day retention period if \`deadLetterQueueEnabled\` is \`true\` The SQS queue to use if DLQ is enabled. --- -##### \`DeadLetterQueueEnabled\`Optional +##### \`DeadLetterQueueEnabled\`Optional \`\`\`csharp public bool DeadLetterQueueEnabled { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false unless \`deadLetterQueue\` is set, which implies DLQ is enabled. Enabled DLQ. @@ -659,26 +658,26 @@ If \`deadLetterQueue\` is undefined, an SQS queue with default options will be d --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description. A description of the function. --- -##### \`Environment\`Optional +##### \`Environment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Environment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. @@ -687,26 +686,26 @@ Use environment variables to apply configuration changes, such as test and produ --- -##### \`EnvironmentEncryption\`Optional +##### \`EnvironmentEncryption\`Optional \`\`\`csharp public IKey EnvironmentEncryption { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.KMS.IKey\`](#Amazon.CDK.AWS.KMS.IKey) +- *Type:* Amazon.CDK.AWS.KMS.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- -##### \`Events\`Optional +##### \`Events\`Optional \`\`\`csharp public IEventSource[] Events { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.IEventSource\`](#Amazon.CDK.AWS.Lambda.IEventSource)[] +- *Type:* Amazon.CDK.AWS.Lambda.IEventSource[] - *Default:* No event sources. Event sources for this function. @@ -715,39 +714,39 @@ You can also add event sources using \`addEventSource\`. --- -##### \`Filesystem\`Optional +##### \`Filesystem\`Optional \`\`\`csharp public FileSystem Filesystem { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.FileSystem\`](#Amazon.CDK.AWS.Lambda.FileSystem) +- *Type:* Amazon.CDK.AWS.Lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- -##### \`FunctionName\`Optional +##### \`FunctionName\`Optional \`\`\`csharp public string FunctionName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- -##### \`InitialPolicy\`Optional +##### \`InitialPolicy\`Optional \`\`\`csharp public PolicyStatement[] InitialPolicy { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement)[] +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement[] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. @@ -756,28 +755,28 @@ You can call \`addToRolePolicy\` to the created lambda to add statements post cr --- -##### \`InsightsVersion\`Optional +##### \`InsightsVersion\`Optional \`\`\`csharp public LambdaInsightsVersion InsightsVersion { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.LambdaInsightsVersion\`](#Amazon.CDK.AWS.Lambda.LambdaInsightsVersion) +- *Type:* Amazon.CDK.AWS.Lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. -> https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html +> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html) --- -##### \`Layers\`Optional +##### \`Layers\`Optional \`\`\`csharp public ILayerVersion[] Layers { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.ILayerVersion\`](#Amazon.CDK.AWS.Lambda.ILayerVersion)[] +- *Type:* Amazon.CDK.AWS.Lambda.ILayerVersion[] - *Default:* No layers. A list of layers to add to the function's execution environment. @@ -786,13 +785,13 @@ You can configure your Lambda function to pull in additional code during initial --- -##### \`LogRetention\`Optional +##### \`LogRetention\`Optional \`\`\`csharp public RetentionDays LogRetention { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Logs.RetentionDays\`](#Amazon.CDK.AWS.Logs.RetentionDays) +- *Type:* Amazon.CDK.AWS.Logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. @@ -801,13 +800,13 @@ When updating this property, unsetting it doesn't remove the log retention polic --- -##### \`LogRetentionRetryOptions\`Optional +##### \`LogRetentionRetryOptions\`Optional \`\`\`csharp public LogRetentionRetryOptions LogRetentionRetryOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions\`](#Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions) +- *Type:* Amazon.CDK.AWS.Lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. @@ -816,26 +815,26 @@ These options control the retry policy when interacting with CloudWatch APIs. --- -##### \`LogRetentionRole\`Optional +##### \`LogRetentionRole\`Optional \`\`\`csharp public IRole LogRetentionRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) +- *Type:* Amazon.CDK.AWS.IAM.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. --- -##### \`MemorySize\`Optional +##### \`MemorySize\`Optional \`\`\`csharp public double MemorySize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. @@ -844,58 +843,58 @@ Lambda uses this value to proportionally allocate the amount of CPU power. For m --- -##### \`Profiling\`Optional +##### \`Profiling\`Optional \`\`\`csharp public bool Profiling { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* No profiling. Enable profiling. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`ProfilingGroup\`Optional +##### \`ProfilingGroup\`Optional \`\`\`csharp public IProfilingGroup ProfilingGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup\`](#Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup) +- *Type:* Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup - *Default:* A new profiling group will be created if \`profiling\` is set. Profiling Group. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`ReservedConcurrentExecutions\`Optional +##### \`ReservedConcurrentExecutions\`Optional \`\`\`csharp public double ReservedConcurrentExecutions { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. -> https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html +> [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.IAM.IRole\`](#Amazon.CDK.AWS.IAM.IRole) +- *Type:* Amazon.CDK.AWS.IAM.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling \`addToRolePolicy\`. Lambda execution role. @@ -904,7 +903,7 @@ This is the role that will be assumed by the function upon execution. It control --- -##### ~~\`SecurityGroup\`~~Optional +##### ~~\`SecurityGroup\`~~Optional - *Deprecated:* - This property is deprecated, use securityGroups instead @@ -912,7 +911,7 @@ This is the role that will be assumed by the function upon execution. It control public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.EC2.ISecurityGroup\`](#Amazon.CDK.AWS.EC2.ISecurityGroup) +- *Type:* Amazon.CDK.AWS.EC2.ISecurityGroup - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function. What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. @@ -921,13 +920,13 @@ Only used if 'vpc' is supplied. Use securityGroups property instead. Function c --- -##### \`SecurityGroups\`Optional +##### \`SecurityGroups\`Optional \`\`\`csharp public ISecurityGroup[] SecurityGroups { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.EC2.ISecurityGroup\`](#Amazon.CDK.AWS.EC2.ISecurityGroup)[] +- *Type:* Amazon.CDK.AWS.EC2.ISecurityGroup[] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. @@ -936,13 +935,13 @@ Only used if 'vpc' is supplied. --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. @@ -951,26 +950,26 @@ Because the execution time affects cost, set this value based on the function's --- -##### \`Tracing\`Optional +##### \`Tracing\`Optional \`\`\`csharp public Tracing Tracing { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.Tracing\`](#Amazon.CDK.AWS.Lambda.Tracing) +- *Type:* Amazon.CDK.AWS.Lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.EC2.IVpc\`](#Amazon.CDK.AWS.EC2.IVpc) +- *Type:* Amazon.CDK.AWS.EC2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. @@ -979,13 +978,13 @@ Specify this if the Lambda function needs to access resources in a VPC. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.EC2.SubnetSelection\`](#Amazon.CDK.AWS.EC2.SubnetSelection) +- *Type:* Amazon.CDK.AWS.EC2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. @@ -994,13 +993,13 @@ Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT --- -##### \`Code\`Required +##### \`Code\`Required \`\`\`csharp public Code Code { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.Code\`](#Amazon.CDK.AWS.Lambda.Code) +- *Type:* Amazon.CDK.AWS.Lambda.Code The source code of your Lambda function. @@ -1008,13 +1007,13 @@ You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket o --- -##### \`Handler\`Required +##### \`Handler\`Required \`\`\`csharp public string Handler { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the method within your code that Lambda calls to execute your function. @@ -1022,13 +1021,13 @@ The format includes the file name. It can also include namespaces and other qual --- -##### \`Runtime\`Required +##### \`Runtime\`Required \`\`\`csharp public Runtime Runtime { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Lambda.Runtime\`](#Amazon.CDK.AWS.Lambda.Runtime) +- *Type:* Amazon.CDK.AWS.Lambda.Runtime The runtime environment for the Lambda function that you are uploading. @@ -1036,13 +1035,13 @@ For valid values, see the Runtime property in the AWS Lambda Developer Guide. U --- -##### \`StackId\`Optional +##### \`StackId\`Optional \`\`\`csharp public string StackId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \`edge-lambda-stack-\${region}\` The stack ID of Lambda@Edge function. @@ -1055,20 +1054,19 @@ The stack ID of Lambda@Edge function. `; exports[`submodules without an explicit name java 1`] = ` -" -# API Reference +"# API Reference -## Constructs +## Constructs -### EdgeFunction +### EdgeFunction -- *Implements:* [\`software.amazon.awscdk.services.lambda.IVersion\`](#software.amazon.awscdk.services.lambda.IVersion) +- *Implements:* software.amazon.awscdk.services.lambda.IVersion A Lambda@Edge function. Convenience resource for requesting a Lambda function in the 'us-east-1' region for use with Lambda@Edge. Implements several restrictions enforced by Lambda@Edge. Note that this construct requires that the 'us-east-1' region has been bootstrapped. See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html or 'cdk bootstrap --help' for options. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.cloudfront.experimental.EdgeFunction; @@ -1117,64 +1115,64 @@ EdgeFunction.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionparameterid)* | \`java.lang.String\` | *No description.* | -| [\`maxEventAge\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametermaxeventage) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The maximum age of a request that Lambda sends to a function for processing. | -| [\`onFailure\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameteronfailure) | [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) | The destination for failed invocations. | -| [\`onSuccess\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameteronsuccess) | [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) | The destination for successful invocations. | -| [\`retryAttempts\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterretryattempts) | \`java.lang.Number\` | The maximum number of times to retry when the function returns an error. | -| [\`allowAllOutbound\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterallowalloutbound) | \`java.lang.Boolean\` | Whether to allow the Lambda to send all network traffic. | -| [\`allowPublicSubnet\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterallowpublicsubnet) | \`java.lang.Boolean\` | Lambda Functions in a public subnet can NOT access the internet. | -| [\`architectures\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterarchitectures) | java.util.List<[\`software.amazon.awscdk.services.lambda.Architecture\`](#software.amazon.awscdk.services.lambda.Architecture)> | The system architectures compatible with this lambda function. | -| [\`codeSigningConfig\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametercodesigningconfig) | [\`software.amazon.awscdk.services.lambda.ICodeSigningConfig\`](#software.amazon.awscdk.services.lambda.ICodeSigningConfig) | Code signing config associated with this function. | -| [\`currentVersionOptions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametercurrentversionoptions) | [\`software.amazon.awscdk.services.lambda.VersionOptions\`](#software.amazon.awscdk.services.lambda.VersionOptions) | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | -| [\`deadLetterQueue\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterdeadletterqueue) | [\`software.amazon.awscdk.services.sqs.IQueue\`](#software.amazon.awscdk.services.sqs.IQueue) | The SQS queue to use if DLQ is enabled. | -| [\`deadLetterQueueEnabled\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterdeadletterqueueenabled) | \`java.lang.Boolean\` | Enabled DLQ. | -| [\`description\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterdescription) | \`java.lang.String\` | A description of the function. | -| [\`environment\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterenvironment) | java.util.Map | Key-value pairs that Lambda caches and makes available for your Lambda functions. | -| [\`environmentEncryption\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterenvironmentencryption) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | The AWS KMS key that's used to encrypt your function's environment variables. | -| [\`events\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterevents) | java.util.List<[\`software.amazon.awscdk.services.lambda.IEventSource\`](#software.amazon.awscdk.services.lambda.IEventSource)> | Event sources for this function. | -| [\`filesystem\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterfilesystem) | [\`software.amazon.awscdk.services.lambda.FileSystem\`](#software.amazon.awscdk.services.lambda.FileSystem) | The filesystem configuration for the lambda function. | -| [\`functionName\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterfunctionname) | \`java.lang.String\` | A name for the function. | -| [\`initialPolicy\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterinitialpolicy) | java.util.List<[\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement)> | Initial policy statements to add to the created Lambda Role. | -| [\`insightsVersion\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterinsightsversion) | [\`software.amazon.awscdk.services.lambda.LambdaInsightsVersion\`](#software.amazon.awscdk.services.lambda.LambdaInsightsVersion) | Specify the version of CloudWatch Lambda insights to use for monitoring. | -| [\`layers\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterlayers) | java.util.List<[\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion)> | A list of layers to add to the function's execution environment. | -| [\`logRetention\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterlogretention) | [\`software.amazon.awscdk.services.logs.RetentionDays\`](#software.amazon.awscdk.services.logs.RetentionDays) | The number of days log events are kept in CloudWatch Logs. | -| [\`logRetentionRetryOptions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterlogretentionretryoptions) | [\`software.amazon.awscdk.services.lambda.LogRetentionRetryOptions\`](#software.amazon.awscdk.services.lambda.LogRetentionRetryOptions) | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | -| [\`logRetentionRole\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterlogretentionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | -| [\`memorySize\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametermemorysize) | \`java.lang.Number\` | The amount of memory, in MB, that is allocated to your Lambda function. | -| [\`profiling\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterprofiling) | \`java.lang.Boolean\` | Enable profiling. | -| [\`profilingGroup\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterprofilinggroup) | [\`software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup\`](#software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup) | Profiling Group. | -| [\`reservedConcurrentExecutions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterreservedconcurrentexecutions) | \`java.lang.Number\` | The maximum of concurrent executions you want to reserve for the function. | -| [\`role\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Lambda execution role. | -| [\`securityGroup\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametersecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | -| [\`securityGroups\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametersecuritygroups) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> | The list of security groups to associate with the Lambda's network interfaces. | -| [\`timeout\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametertimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The function execution time (in seconds) after which Lambda terminates the function. | -| [\`tracing\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametertracing) | [\`software.amazon.awscdk.services.lambda.Tracing\`](#software.amazon.awscdk.services.lambda.Tracing) | Enable AWS X-Ray Tracing for Lambda Function. | -| [\`vpc\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | VPC network to place Lambda network interfaces. | -| [\`vpcSubnets\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametervpcsubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Where to place the network interfaces within the VPC. | -| [\`code\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparametercode)* | [\`software.amazon.awscdk.services.lambda.Code\`](#software.amazon.awscdk.services.lambda.Code) | The source code of your Lambda function. | -| [\`handler\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterhandler)* | \`java.lang.String\` | The name of the method within your code that Lambda calls to execute your function. | -| [\`runtime\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterruntime)* | [\`software.amazon.awscdk.services.lambda.Runtime\`](#software.amazon.awscdk.services.lambda.Runtime) | The runtime environment for the Lambda function that you are uploading. | -| [\`stackId\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropsparameterstackid) | \`java.lang.String\` | The stack ID of Lambda@Edge function. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`maxEventAge\`Optional - -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| maxEventAge | software.amazon.awscdk.core.Duration | The maximum age of a request that Lambda sends to a function for processing. | +| onFailure | software.amazon.awscdk.services.lambda.IDestination | The destination for failed invocations. | +| onSuccess | software.amazon.awscdk.services.lambda.IDestination | The destination for successful invocations. | +| retryAttempts | java.lang.Number | The maximum number of times to retry when the function returns an error. | +| allowAllOutbound | java.lang.Boolean | Whether to allow the Lambda to send all network traffic. | +| allowPublicSubnet | java.lang.Boolean | Lambda Functions in a public subnet can NOT access the internet. | +| architectures | java.util.List | The system architectures compatible with this lambda function. | +| codeSigningConfig | software.amazon.awscdk.services.lambda.ICodeSigningConfig | Code signing config associated with this function. | +| currentVersionOptions | software.amazon.awscdk.services.lambda.VersionOptions | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | +| deadLetterQueue | software.amazon.awscdk.services.sqs.IQueue | The SQS queue to use if DLQ is enabled. | +| deadLetterQueueEnabled | java.lang.Boolean | Enabled DLQ. | +| description | java.lang.String | A description of the function. | +| environment | java.util.Map | Key-value pairs that Lambda caches and makes available for your Lambda functions. | +| environmentEncryption | software.amazon.awscdk.services.kms.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | +| events | java.util.List | Event sources for this function. | +| filesystem | software.amazon.awscdk.services.lambda.FileSystem | The filesystem configuration for the lambda function. | +| functionName | java.lang.String | A name for the function. | +| initialPolicy | java.util.List | Initial policy statements to add to the created Lambda Role. | +| insightsVersion | software.amazon.awscdk.services.lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | +| layers | java.util.List | A list of layers to add to the function's execution environment. | +| logRetention | software.amazon.awscdk.services.logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | +| logRetentionRetryOptions | software.amazon.awscdk.services.lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | +| logRetentionRole | software.amazon.awscdk.services.iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | +| memorySize | java.lang.Number | The amount of memory, in MB, that is allocated to your Lambda function. | +| profiling | java.lang.Boolean | Enable profiling. | +| profilingGroup | software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup | Profiling Group. | +| reservedConcurrentExecutions | java.lang.Number | The maximum of concurrent executions you want to reserve for the function. | +| role | software.amazon.awscdk.services.iam.IRole | Lambda execution role. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | +| securityGroups | java.util.List | The list of security groups to associate with the Lambda's network interfaces. | +| timeout | software.amazon.awscdk.core.Duration | The function execution time (in seconds) after which Lambda terminates the function. | +| tracing | software.amazon.awscdk.services.lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | VPC network to place Lambda network interfaces. | +| vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | Where to place the network interfaces within the VPC. | +| code | software.amazon.awscdk.services.lambda.Code | The source code of your Lambda function. | +| handler | java.lang.String | The name of the method within your code that Lambda calls to execute your function. | +| runtime | software.amazon.awscdk.services.lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | +| stackId | java.lang.String | The stack ID of Lambda@Edge function. | + +--- + +##### \`scope\`Required + +- *Type:* software.constructs.Construct + +--- + +##### \`id\`Required + +- *Type:* java.lang.String + +--- + +##### \`maxEventAge\`Optional + +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -1183,27 +1181,27 @@ Minimum: 60 seconds Maximum: 6 hours --- -##### \`onFailure\`Optional +##### \`onFailure\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) +- *Type:* software.amazon.awscdk.services.lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -##### \`onSuccess\`Optional +##### \`onSuccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) +- *Type:* software.amazon.awscdk.services.lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -##### \`retryAttempts\`Optional +##### \`retryAttempts\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -1212,9 +1210,9 @@ Minimum: 0 Maximum: 2 --- -##### \`allowAllOutbound\`Optional +##### \`allowAllOutbound\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Whether to allow the Lambda to send all network traffic. @@ -1223,58 +1221,58 @@ If set to false, you must individually add traffic rules to allow the Lambda to --- -##### \`allowPublicSubnet\`Optional +##### \`allowPublicSubnet\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. -> https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841 +> [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- -##### \`architectures\`Optional +##### \`architectures\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.Architecture\`](#software.amazon.awscdk.services.lambda.Architecture)> +- *Type:* java.util.List - *Default:* [Architecture.X86_64] The system architectures compatible with this lambda function. --- -##### \`codeSigningConfig\`Optional +##### \`codeSigningConfig\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.ICodeSigningConfig\`](#software.amazon.awscdk.services.lambda.ICodeSigningConfig) +- *Type:* software.amazon.awscdk.services.lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- -##### \`currentVersionOptions\`Optional +##### \`currentVersionOptions\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.VersionOptions\`](#software.amazon.awscdk.services.lambda.VersionOptions) +- *Type:* software.amazon.awscdk.services.lambda.VersionOptions - *Default:* default options as described in \`VersionOptions\` Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. --- -##### \`deadLetterQueue\`Optional +##### \`deadLetterQueue\`Optional -- *Type:* [\`software.amazon.awscdk.services.sqs.IQueue\`](#software.amazon.awscdk.services.sqs.IQueue) +- *Type:* software.amazon.awscdk.services.sqs.IQueue - *Default:* SQS queue with 14 day retention period if \`deadLetterQueueEnabled\` is \`true\` The SQS queue to use if DLQ is enabled. --- -##### \`deadLetterQueueEnabled\`Optional +##### \`deadLetterQueueEnabled\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false unless \`deadLetterQueue\` is set, which implies DLQ is enabled. Enabled DLQ. @@ -1283,18 +1281,18 @@ If \`deadLetterQueue\` is undefined, an SQS queue with default options will be d --- -##### \`description\`Optional +##### \`description\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No description. A description of the function. --- -##### \`environment\`Optional +##### \`environment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. @@ -1303,18 +1301,18 @@ Use environment variables to apply configuration changes, such as test and produ --- -##### \`environmentEncryption\`Optional +##### \`environmentEncryption\`Optional -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- -##### \`events\`Optional +##### \`events\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.IEventSource\`](#software.amazon.awscdk.services.lambda.IEventSource)> +- *Type:* java.util.List - *Default:* No event sources. Event sources for this function. @@ -1323,27 +1321,27 @@ You can also add event sources using \`addEventSource\`. --- -##### \`filesystem\`Optional +##### \`filesystem\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.FileSystem\`](#software.amazon.awscdk.services.lambda.FileSystem) +- *Type:* software.amazon.awscdk.services.lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- -##### \`functionName\`Optional +##### \`functionName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- -##### \`initialPolicy\`Optional +##### \`initialPolicy\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement)> +- *Type:* java.util.List - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. @@ -1352,20 +1350,20 @@ You can call \`addToRolePolicy\` to the created lambda to add statements post cr --- -##### \`insightsVersion\`Optional +##### \`insightsVersion\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.LambdaInsightsVersion\`](#software.amazon.awscdk.services.lambda.LambdaInsightsVersion) +- *Type:* software.amazon.awscdk.services.lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. -> https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html +> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html) --- -##### \`layers\`Optional +##### \`layers\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion)> +- *Type:* java.util.List - *Default:* No layers. A list of layers to add to the function's execution environment. @@ -1374,9 +1372,9 @@ You can configure your Lambda function to pull in additional code during initial --- -##### \`logRetention\`Optional +##### \`logRetention\`Optional -- *Type:* [\`software.amazon.awscdk.services.logs.RetentionDays\`](#software.amazon.awscdk.services.logs.RetentionDays) +- *Type:* software.amazon.awscdk.services.logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. @@ -1385,9 +1383,9 @@ When updating this property, unsetting it doesn't remove the log retention polic --- -##### \`logRetentionRetryOptions\`Optional +##### \`logRetentionRetryOptions\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.LogRetentionRetryOptions\`](#software.amazon.awscdk.services.lambda.LogRetentionRetryOptions) +- *Type:* software.amazon.awscdk.services.lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. @@ -1396,18 +1394,18 @@ These options control the retry policy when interacting with CloudWatch APIs. --- -##### \`logRetentionRole\`Optional +##### \`logRetentionRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. --- -##### \`memorySize\`Optional +##### \`memorySize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. @@ -1416,42 +1414,42 @@ Lambda uses this value to proportionally allocate the amount of CPU power. For m --- -##### \`profiling\`Optional +##### \`profiling\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* No profiling. Enable profiling. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`profilingGroup\`Optional +##### \`profilingGroup\`Optional -- *Type:* [\`software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup\`](#software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup) +- *Type:* software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if \`profiling\` is set. Profiling Group. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`reservedConcurrentExecutions\`Optional +##### \`reservedConcurrentExecutions\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. -> https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html +> [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling \`addToRolePolicy\`. Lambda execution role. @@ -1460,11 +1458,11 @@ This is the role that will be assumed by the function upon execution. It control --- -##### ~~\`securityGroup\`~~Optional +##### ~~\`securityGroup\`~~Optional - *Deprecated:* - This property is deprecated, use securityGroups instead -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function. What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. @@ -1473,9 +1471,9 @@ Only used if 'vpc' is supplied. Use securityGroups property instead. Function c --- -##### \`securityGroups\`Optional +##### \`securityGroups\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> +- *Type:* java.util.List - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. @@ -1484,9 +1482,9 @@ Only used if 'vpc' is supplied. --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. @@ -1495,18 +1493,18 @@ Because the execution time affects cost, set this value based on the function's --- -##### \`tracing\`Optional +##### \`tracing\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.Tracing\`](#software.amazon.awscdk.services.lambda.Tracing) +- *Type:* software.amazon.awscdk.services.lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. @@ -1515,9 +1513,9 @@ Specify this if the Lambda function needs to access resources in a VPC. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. @@ -1526,9 +1524,9 @@ Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT --- -##### \`code\`Required +##### \`code\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.Code\`](#software.amazon.awscdk.services.lambda.Code) +- *Type:* software.amazon.awscdk.services.lambda.Code The source code of your Lambda function. @@ -1536,9 +1534,9 @@ You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket o --- -##### \`handler\`Required +##### \`handler\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the method within your code that Lambda calls to execute your function. @@ -1546,9 +1544,9 @@ The format includes the file name. It can also include namespaces and other qual --- -##### \`runtime\`Required +##### \`runtime\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.Runtime\`](#software.amazon.awscdk.services.lambda.Runtime) +- *Type:* software.amazon.awscdk.services.lambda.Runtime The runtime environment for the Lambda function that you are uploading. @@ -1556,235 +1554,235 @@ For valid values, see the Runtime property in the AWS Lambda Developer Guide. U --- -##### \`stackId\`Optional +##### \`stackId\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \`edge-lambda-stack-\${region}\` The stack ID of Lambda@Edge function. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAlias\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionaddalias) | Defines an alias for this version. | -| [\`addEventSource\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionaddeventsource) | Adds an event source to this function. | -| [\`addEventSourceMapping\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionaddeventsourcemapping) | Adds an event source that maps to this AWS Lambda function. | -| [\`addPermission\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionaddpermission) | Adds a permission to the Lambda resource policy. | -| [\`addToRolePolicy\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionaddtorolepolicy) | Adds a statement to the IAM role assumed by the instance. | -| [\`configureAsyncInvoke\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionconfigureasyncinvoke) | Configures options for asynchronous invocation. | -| [\`grantInvoke\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctiongrantinvoke) | Grant the given identity permissions to invoke this Lambda. | -| [\`metric\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionmetric) | Return the given named metric for this Lambda Return the given named metric for this Function. | -| [\`metricDuration\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionmetricduration) | Metric for the Duration of this Lambda How long execution of this Lambda takes. | -| [\`metricErrors\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionmetricerrors) | How many invocations of this Lambda fail. | -| [\`metricInvocations\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionmetricinvocations) | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | -| [\`metricThrottles\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionmetricthrottles) | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | +| addAlias | Defines an alias for this version. | +| addEventSource | Adds an event source to this function. | +| addEventSourceMapping | Adds an event source that maps to this AWS Lambda function. | +| addPermission | Adds a permission to the Lambda resource policy. | +| addToRolePolicy | Adds a statement to the IAM role assumed by the instance. | +| configureAsyncInvoke | Configures options for asynchronous invocation. | +| grantInvoke | Grant the given identity permissions to invoke this Lambda. | +| metric | Return the given named metric for this Lambda Return the given named metric for this Function. | +| metricDuration | Metric for the Duration of this Lambda How long execution of this Lambda takes. | +| metricErrors | How many invocations of this Lambda fail. | +| metricInvocations | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | +| metricThrottles | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | --- -##### \`addAlias\` +##### \`addAlias\` \`\`\`java public addAlias(java.lang.String aliasName) public addAlias(java.lang.String aliasName, AliasOptions options) \`\`\` -###### \`aliasName\`Required +###### \`aliasName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.AliasOptions\`](#software.amazon.awscdk.services.lambda.AliasOptions) +- *Type:* software.amazon.awscdk.services.lambda.AliasOptions --- -##### \`addEventSource\` +##### \`addEventSource\` \`\`\`java public addEventSource(IEventSource source) \`\`\` -###### \`source\`Required +###### \`source\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.IEventSource\`](#software.amazon.awscdk.services.lambda.IEventSource) +- *Type:* software.amazon.awscdk.services.lambda.IEventSource --- -##### \`addEventSourceMapping\` +##### \`addEventSourceMapping\` \`\`\`java public addEventSourceMapping(java.lang.String id, EventSourceMappingOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.EventSourceMappingOptions\`](#software.amazon.awscdk.services.lambda.EventSourceMappingOptions) +- *Type:* software.amazon.awscdk.services.lambda.EventSourceMappingOptions --- -##### \`addPermission\` +##### \`addPermission\` \`\`\`java public addPermission(java.lang.String id, Permission permission) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`permission\`Required +###### \`permission\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.Permission\`](#software.amazon.awscdk.services.lambda.Permission) +- *Type:* software.amazon.awscdk.services.lambda.Permission --- -##### \`addToRolePolicy\` +##### \`addToRolePolicy\` \`\`\`java public addToRolePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`configureAsyncInvoke\` +##### \`configureAsyncInvoke\` \`\`\`java public configureAsyncInvoke(EventInvokeConfigOptions options) \`\`\` -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.lambda.EventInvokeConfigOptions\`](#software.amazon.awscdk.services.lambda.EventInvokeConfigOptions) +- *Type:* software.amazon.awscdk.services.lambda.EventInvokeConfigOptions --- -##### \`grantInvoke\` +##### \`grantInvoke\` \`\`\`java public grantInvoke(IGrantable identity) \`\`\` -###### \`identity\`Required +###### \`identity\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`metric\` +##### \`metric\` \`\`\`java public metric(java.lang.String metricName) public metric(java.lang.String metricName, MetricOptions props) \`\`\` -###### \`metricName\`Required +###### \`metricName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`props\`Optional +###### \`props\`Optional -- *Type:* [\`software.amazon.awscdk.services.cloudwatch.MetricOptions\`](#software.amazon.awscdk.services.cloudwatch.MetricOptions) +- *Type:* software.amazon.awscdk.services.cloudwatch.MetricOptions --- -##### \`metricDuration\` +##### \`metricDuration\` \`\`\`java public metricDuration() public metricDuration(MetricOptions props) \`\`\` -###### \`props\`Optional +###### \`props\`Optional -- *Type:* [\`software.amazon.awscdk.services.cloudwatch.MetricOptions\`](#software.amazon.awscdk.services.cloudwatch.MetricOptions) +- *Type:* software.amazon.awscdk.services.cloudwatch.MetricOptions --- -##### \`metricErrors\` +##### \`metricErrors\` \`\`\`java public metricErrors() public metricErrors(MetricOptions props) \`\`\` -###### \`props\`Optional +###### \`props\`Optional -- *Type:* [\`software.amazon.awscdk.services.cloudwatch.MetricOptions\`](#software.amazon.awscdk.services.cloudwatch.MetricOptions) +- *Type:* software.amazon.awscdk.services.cloudwatch.MetricOptions --- -##### \`metricInvocations\` +##### \`metricInvocations\` \`\`\`java public metricInvocations() public metricInvocations(MetricOptions props) \`\`\` -###### \`props\`Optional +###### \`props\`Optional -- *Type:* [\`software.amazon.awscdk.services.cloudwatch.MetricOptions\`](#software.amazon.awscdk.services.cloudwatch.MetricOptions) +- *Type:* software.amazon.awscdk.services.cloudwatch.MetricOptions --- -##### \`metricThrottles\` +##### \`metricThrottles\` \`\`\`java public metricThrottles() public metricThrottles(MetricOptions props) \`\`\` -###### \`props\`Optional +###### \`props\`Optional -- *Type:* [\`software.amazon.awscdk.services.cloudwatch.MetricOptions\`](#software.amazon.awscdk.services.cloudwatch.MetricOptions) +- *Type:* software.amazon.awscdk.services.cloudwatch.MetricOptions --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`connections\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyconnections)* | [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) | Not supported. | -| [\`currentVersion\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertycurrentversion)* | [\`software.amazon.awscdk.services.lambda.IVersion\`](#software.amazon.awscdk.services.lambda.IVersion) | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | -| [\`edgeArn\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyedgearn)* | \`java.lang.String\` | The ARN of the version for Lambda@Edge. | -| [\`functionArn\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyfunctionarn)* | \`java.lang.String\` | The ARN of the function. | -| [\`functionName\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyfunctionname)* | \`java.lang.String\` | The name of the function. | -| [\`grantPrincipal\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertygrantprincipal)* | [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) | The principal to grant permissions to. | -| [\`isBoundToVpc\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyisboundtovpc)* | \`java.lang.Boolean\` | Whether or not this Lambda function was bound to a VPC. | -| [\`lambda\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertylambda)* | [\`software.amazon.awscdk.services.lambda.IFunction\`](#software.amazon.awscdk.services.lambda.IFunction) | The underlying AWS Lambda function. | -| [\`latestVersion\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertylatestversion)* | [\`software.amazon.awscdk.services.lambda.IVersion\`](#software.amazon.awscdk.services.lambda.IVersion) | The \`$LATEST\` version of this function. | -| [\`permissionsNode\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertypermissionsnode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct node where permissions are attached. | -| [\`version\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyversion)* | \`java.lang.String\` | The most recently deployed version of this function. | -| [\`role\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role associated with this function. | +| connections | software.amazon.awscdk.services.ec2.Connections | Not supported. | +| currentVersion | software.amazon.awscdk.services.lambda.IVersion | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | +| edgeArn | java.lang.String | The ARN of the version for Lambda@Edge. | +| functionArn | java.lang.String | The ARN of the function. | +| functionName | java.lang.String | The name of the function. | +| grantPrincipal | software.amazon.awscdk.services.iam.IPrincipal | The principal to grant permissions to. | +| isBoundToVpc | java.lang.Boolean | Whether or not this Lambda function was bound to a VPC. | +| lambda | software.amazon.awscdk.services.lambda.IFunction | The underlying AWS Lambda function. | +| latestVersion | software.amazon.awscdk.services.lambda.IVersion | The \`$LATEST\` version of this function. | +| permissionsNode | software.amazon.awscdk.core.ConstructNode | The construct node where permissions are attached. | +| version | java.lang.String | The most recently deployed version of this function. | +| role | software.amazon.awscdk.services.iam.IRole | The IAM role associated with this function. | --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`java public Connections getConnections(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) +- *Type:* software.amazon.awscdk.services.ec2.Connections Not supported. @@ -1792,73 +1790,73 @@ Connections are only applicable to VPC-enabled functions. --- -##### \`currentVersion\`Required +##### \`currentVersion\`Required \`\`\`java public IVersion getCurrentVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.IVersion\`](#software.amazon.awscdk.services.lambda.IVersion) +- *Type:* software.amazon.awscdk.services.lambda.IVersion Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. --- -##### \`edgeArn\`Required +##### \`edgeArn\`Required \`\`\`java public java.lang.String getEdgeArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the version for Lambda@Edge. --- -##### \`functionArn\`Required +##### \`functionArn\`Required \`\`\`java public java.lang.String getFunctionArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the function. --- -##### \`functionName\`Required +##### \`functionName\`Required \`\`\`java public java.lang.String getFunctionName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the function. --- -##### \`grantPrincipal\`Required +##### \`grantPrincipal\`Required \`\`\`java public IPrincipal getGrantPrincipal(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) +- *Type:* software.amazon.awscdk.services.iam.IPrincipal The principal to grant permissions to. --- -##### \`isBoundToVpc\`Required +##### \`isBoundToVpc\`Required \`\`\`java public java.lang.Boolean getIsBoundToVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean Whether or not this Lambda function was bound to a VPC. @@ -1866,25 +1864,25 @@ If this is is \`false\`, trying to access the \`connections\` object will fail. --- -##### \`lambda\`Required +##### \`lambda\`Required \`\`\`java public IFunction getLambda(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.IFunction\`](#software.amazon.awscdk.services.lambda.IFunction) +- *Type:* software.amazon.awscdk.services.lambda.IFunction The underlying AWS Lambda function. --- -##### \`latestVersion\`Required +##### \`latestVersion\`Required \`\`\`java public IVersion getLatestVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.IVersion\`](#software.amazon.awscdk.services.lambda.IVersion) +- *Type:* software.amazon.awscdk.services.lambda.IVersion The \`$LATEST\` version of this function. @@ -1892,50 +1890,50 @@ Note that this is reference to a non-specific AWS Lambda version, which means th --- -##### \`permissionsNode\`Required +##### \`permissionsNode\`Required \`\`\`java public ConstructNode getPermissionsNode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct node where permissions are attached. --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The most recently deployed version of this function. --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The IAM role associated with this function. --- -## Structs +## Structs -### EdgeFunctionProps +### EdgeFunctionProps Properties for creating a Lambda@Edge function. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.cloudfront.experimental.EdgeFunctionProps; @@ -1982,58 +1980,58 @@ EdgeFunctionProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`maxEventAge\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertymaxeventage) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The maximum age of a request that Lambda sends to a function for processing. | -| [\`onFailure\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyonfailure) | [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) | The destination for failed invocations. | -| [\`onSuccess\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyonsuccess) | [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) | The destination for successful invocations. | -| [\`retryAttempts\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyretryattempts) | \`java.lang.Number\` | The maximum number of times to retry when the function returns an error. | -| [\`allowAllOutbound\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyallowalloutbound) | \`java.lang.Boolean\` | Whether to allow the Lambda to send all network traffic. | -| [\`allowPublicSubnet\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyallowpublicsubnet) | \`java.lang.Boolean\` | Lambda Functions in a public subnet can NOT access the internet. | -| [\`architectures\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyarchitectures) | java.util.List<[\`software.amazon.awscdk.services.lambda.Architecture\`](#software.amazon.awscdk.services.lambda.Architecture)> | The system architectures compatible with this lambda function. | -| [\`codeSigningConfig\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertycodesigningconfig) | [\`software.amazon.awscdk.services.lambda.ICodeSigningConfig\`](#software.amazon.awscdk.services.lambda.ICodeSigningConfig) | Code signing config associated with this function. | -| [\`currentVersionOptions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertycurrentversionoptions) | [\`software.amazon.awscdk.services.lambda.VersionOptions\`](#software.amazon.awscdk.services.lambda.VersionOptions) | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | -| [\`deadLetterQueue\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertydeadletterqueue) | [\`software.amazon.awscdk.services.sqs.IQueue\`](#software.amazon.awscdk.services.sqs.IQueue) | The SQS queue to use if DLQ is enabled. | -| [\`deadLetterQueueEnabled\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertydeadletterqueueenabled) | \`java.lang.Boolean\` | Enabled DLQ. | -| [\`description\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertydescription) | \`java.lang.String\` | A description of the function. | -| [\`environment\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyenvironment) | java.util.Map | Key-value pairs that Lambda caches and makes available for your Lambda functions. | -| [\`environmentEncryption\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyenvironmentencryption) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | The AWS KMS key that's used to encrypt your function's environment variables. | -| [\`events\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyevents) | java.util.List<[\`software.amazon.awscdk.services.lambda.IEventSource\`](#software.amazon.awscdk.services.lambda.IEventSource)> | Event sources for this function. | -| [\`filesystem\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyfilesystem) | [\`software.amazon.awscdk.services.lambda.FileSystem\`](#software.amazon.awscdk.services.lambda.FileSystem) | The filesystem configuration for the lambda function. | -| [\`functionName\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyfunctionname) | \`java.lang.String\` | A name for the function. | -| [\`initialPolicy\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyinitialpolicy) | java.util.List<[\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement)> | Initial policy statements to add to the created Lambda Role. | -| [\`insightsVersion\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyinsightsversion) | [\`software.amazon.awscdk.services.lambda.LambdaInsightsVersion\`](#software.amazon.awscdk.services.lambda.LambdaInsightsVersion) | Specify the version of CloudWatch Lambda insights to use for monitoring. | -| [\`layers\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertylayers) | java.util.List<[\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion)> | A list of layers to add to the function's execution environment. | -| [\`logRetention\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertylogretention) | [\`software.amazon.awscdk.services.logs.RetentionDays\`](#software.amazon.awscdk.services.logs.RetentionDays) | The number of days log events are kept in CloudWatch Logs. | -| [\`logRetentionRetryOptions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertylogretentionretryoptions) | [\`software.amazon.awscdk.services.lambda.LogRetentionRetryOptions\`](#software.amazon.awscdk.services.lambda.LogRetentionRetryOptions) | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | -| [\`logRetentionRole\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertylogretentionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | -| [\`memorySize\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertymemorysize) | \`java.lang.Number\` | The amount of memory, in MB, that is allocated to your Lambda function. | -| [\`profiling\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyprofiling) | \`java.lang.Boolean\` | Enable profiling. | -| [\`profilingGroup\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyprofilinggroup) | [\`software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup\`](#software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup) | Profiling Group. | -| [\`reservedConcurrentExecutions\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyreservedconcurrentexecutions) | \`java.lang.Number\` | The maximum of concurrent executions you want to reserve for the function. | -| [\`role\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Lambda execution role. | -| [\`securityGroup\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | -| [\`securityGroups\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertysecuritygroups) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> | The list of security groups to associate with the Lambda's network interfaces. | -| [\`timeout\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertytimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The function execution time (in seconds) after which Lambda terminates the function. | -| [\`tracing\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertytracing) | [\`software.amazon.awscdk.services.lambda.Tracing\`](#software.amazon.awscdk.services.lambda.Tracing) | Enable AWS X-Ray Tracing for Lambda Function. | -| [\`vpc\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | VPC network to place Lambda network interfaces. | -| [\`vpcSubnets\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyvpcsubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Where to place the network interfaces within the VPC. | -| [\`code\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertycode)* | [\`software.amazon.awscdk.services.lambda.Code\`](#software.amazon.awscdk.services.lambda.Code) | The source code of your Lambda function. | -| [\`handler\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyhandler)* | \`java.lang.String\` | The name of the method within your code that Lambda calls to execute your function. | -| [\`runtime\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertyruntime)* | [\`software.amazon.awscdk.services.lambda.Runtime\`](#software.amazon.awscdk.services.lambda.Runtime) | The runtime environment for the Lambda function that you are uploading. | -| [\`stackId\`](#softwareamazonawscdkservicescloudfrontexperimentaledgefunctionpropspropertystackid) | \`java.lang.String\` | The stack ID of Lambda@Edge function. | - ---- - -##### \`maxEventAge\`Optional +| maxEventAge | software.amazon.awscdk.core.Duration | The maximum age of a request that Lambda sends to a function for processing. | +| onFailure | software.amazon.awscdk.services.lambda.IDestination | The destination for failed invocations. | +| onSuccess | software.amazon.awscdk.services.lambda.IDestination | The destination for successful invocations. | +| retryAttempts | java.lang.Number | The maximum number of times to retry when the function returns an error. | +| allowAllOutbound | java.lang.Boolean | Whether to allow the Lambda to send all network traffic. | +| allowPublicSubnet | java.lang.Boolean | Lambda Functions in a public subnet can NOT access the internet. | +| architectures | java.util.List | The system architectures compatible with this lambda function. | +| codeSigningConfig | software.amazon.awscdk.services.lambda.ICodeSigningConfig | Code signing config associated with this function. | +| currentVersionOptions | software.amazon.awscdk.services.lambda.VersionOptions | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | +| deadLetterQueue | software.amazon.awscdk.services.sqs.IQueue | The SQS queue to use if DLQ is enabled. | +| deadLetterQueueEnabled | java.lang.Boolean | Enabled DLQ. | +| description | java.lang.String | A description of the function. | +| environment | java.util.Map | Key-value pairs that Lambda caches and makes available for your Lambda functions. | +| environmentEncryption | software.amazon.awscdk.services.kms.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | +| events | java.util.List | Event sources for this function. | +| filesystem | software.amazon.awscdk.services.lambda.FileSystem | The filesystem configuration for the lambda function. | +| functionName | java.lang.String | A name for the function. | +| initialPolicy | java.util.List | Initial policy statements to add to the created Lambda Role. | +| insightsVersion | software.amazon.awscdk.services.lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | +| layers | java.util.List | A list of layers to add to the function's execution environment. | +| logRetention | software.amazon.awscdk.services.logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | +| logRetentionRetryOptions | software.amazon.awscdk.services.lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | +| logRetentionRole | software.amazon.awscdk.services.iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | +| memorySize | java.lang.Number | The amount of memory, in MB, that is allocated to your Lambda function. | +| profiling | java.lang.Boolean | Enable profiling. | +| profilingGroup | software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup | Profiling Group. | +| reservedConcurrentExecutions | java.lang.Number | The maximum of concurrent executions you want to reserve for the function. | +| role | software.amazon.awscdk.services.iam.IRole | Lambda execution role. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | +| securityGroups | java.util.List | The list of security groups to associate with the Lambda's network interfaces. | +| timeout | software.amazon.awscdk.core.Duration | The function execution time (in seconds) after which Lambda terminates the function. | +| tracing | software.amazon.awscdk.services.lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | VPC network to place Lambda network interfaces. | +| vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | Where to place the network interfaces within the VPC. | +| code | software.amazon.awscdk.services.lambda.Code | The source code of your Lambda function. | +| handler | java.lang.String | The name of the method within your code that Lambda calls to execute your function. | +| runtime | software.amazon.awscdk.services.lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | +| stackId | java.lang.String | The stack ID of Lambda@Edge function. | + +--- + +##### \`maxEventAge\`Optional \`\`\`java public Duration getMaxEventAge(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -2042,39 +2040,39 @@ Minimum: 60 seconds Maximum: 6 hours --- -##### \`onFailure\`Optional +##### \`onFailure\`Optional \`\`\`java public IDestination getOnFailure(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) +- *Type:* software.amazon.awscdk.services.lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -##### \`onSuccess\`Optional +##### \`onSuccess\`Optional \`\`\`java public IDestination getOnSuccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.IDestination\`](#software.amazon.awscdk.services.lambda.IDestination) +- *Type:* software.amazon.awscdk.services.lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -##### \`retryAttempts\`Optional +##### \`retryAttempts\`Optional \`\`\`java public java.lang.Number getRetryAttempts(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -2083,13 +2081,13 @@ Minimum: 0 Maximum: 2 --- -##### \`allowAllOutbound\`Optional +##### \`allowAllOutbound\`Optional \`\`\`java public java.lang.Boolean getAllowAllOutbound(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Whether to allow the Lambda to send all network traffic. @@ -2098,82 +2096,82 @@ If set to false, you must individually add traffic rules to allow the Lambda to --- -##### \`allowPublicSubnet\`Optional +##### \`allowPublicSubnet\`Optional \`\`\`java public java.lang.Boolean getAllowPublicSubnet(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. -> https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841 +> [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- -##### \`architectures\`Optional +##### \`architectures\`Optional \`\`\`java public java.util.List getArchitectures(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.Architecture\`](#software.amazon.awscdk.services.lambda.Architecture)> +- *Type:* java.util.List - *Default:* [Architecture.X86_64] The system architectures compatible with this lambda function. --- -##### \`codeSigningConfig\`Optional +##### \`codeSigningConfig\`Optional \`\`\`java public ICodeSigningConfig getCodeSigningConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ICodeSigningConfig\`](#software.amazon.awscdk.services.lambda.ICodeSigningConfig) +- *Type:* software.amazon.awscdk.services.lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- -##### \`currentVersionOptions\`Optional +##### \`currentVersionOptions\`Optional \`\`\`java public VersionOptions getCurrentVersionOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.VersionOptions\`](#software.amazon.awscdk.services.lambda.VersionOptions) +- *Type:* software.amazon.awscdk.services.lambda.VersionOptions - *Default:* default options as described in \`VersionOptions\` Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. --- -##### \`deadLetterQueue\`Optional +##### \`deadLetterQueue\`Optional \`\`\`java public IQueue getDeadLetterQueue(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.sqs.IQueue\`](#software.amazon.awscdk.services.sqs.IQueue) +- *Type:* software.amazon.awscdk.services.sqs.IQueue - *Default:* SQS queue with 14 day retention period if \`deadLetterQueueEnabled\` is \`true\` The SQS queue to use if DLQ is enabled. --- -##### \`deadLetterQueueEnabled\`Optional +##### \`deadLetterQueueEnabled\`Optional \`\`\`java public java.lang.Boolean getDeadLetterQueueEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false unless \`deadLetterQueue\` is set, which implies DLQ is enabled. Enabled DLQ. @@ -2182,26 +2180,26 @@ If \`deadLetterQueue\` is undefined, an SQS queue with default options will be d --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`java public java.lang.String getDescription(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No description. A description of the function. --- -##### \`environment\`Optional +##### \`environment\`Optional \`\`\`java public java.util.Map getEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. @@ -2210,26 +2208,26 @@ Use environment variables to apply configuration changes, such as test and produ --- -##### \`environmentEncryption\`Optional +##### \`environmentEncryption\`Optional \`\`\`java public IKey getEnvironmentEncryption(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- -##### \`events\`Optional +##### \`events\`Optional \`\`\`java public java.util.List getEvents(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.IEventSource\`](#software.amazon.awscdk.services.lambda.IEventSource)> +- *Type:* java.util.List - *Default:* No event sources. Event sources for this function. @@ -2238,39 +2236,39 @@ You can also add event sources using \`addEventSource\`. --- -##### \`filesystem\`Optional +##### \`filesystem\`Optional \`\`\`java public FileSystem getFilesystem(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.FileSystem\`](#software.amazon.awscdk.services.lambda.FileSystem) +- *Type:* software.amazon.awscdk.services.lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- -##### \`functionName\`Optional +##### \`functionName\`Optional \`\`\`java public java.lang.String getFunctionName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- -##### \`initialPolicy\`Optional +##### \`initialPolicy\`Optional \`\`\`java public java.util.List getInitialPolicy(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement)> +- *Type:* java.util.List - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. @@ -2279,28 +2277,28 @@ You can call \`addToRolePolicy\` to the created lambda to add statements post cr --- -##### \`insightsVersion\`Optional +##### \`insightsVersion\`Optional \`\`\`java public LambdaInsightsVersion getInsightsVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.LambdaInsightsVersion\`](#software.amazon.awscdk.services.lambda.LambdaInsightsVersion) +- *Type:* software.amazon.awscdk.services.lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. -> https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html +> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html) --- -##### \`layers\`Optional +##### \`layers\`Optional \`\`\`java public java.util.List getLayers(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion)> +- *Type:* java.util.List - *Default:* No layers. A list of layers to add to the function's execution environment. @@ -2309,13 +2307,13 @@ You can configure your Lambda function to pull in additional code during initial --- -##### \`logRetention\`Optional +##### \`logRetention\`Optional \`\`\`java public RetentionDays getLogRetention(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.logs.RetentionDays\`](#software.amazon.awscdk.services.logs.RetentionDays) +- *Type:* software.amazon.awscdk.services.logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. @@ -2324,13 +2322,13 @@ When updating this property, unsetting it doesn't remove the log retention polic --- -##### \`logRetentionRetryOptions\`Optional +##### \`logRetentionRetryOptions\`Optional \`\`\`java public LogRetentionRetryOptions getLogRetentionRetryOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.LogRetentionRetryOptions\`](#software.amazon.awscdk.services.lambda.LogRetentionRetryOptions) +- *Type:* software.amazon.awscdk.services.lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. @@ -2339,26 +2337,26 @@ These options control the retry policy when interacting with CloudWatch APIs. --- -##### \`logRetentionRole\`Optional +##### \`logRetentionRole\`Optional \`\`\`java public IRole getLogRetentionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. --- -##### \`memorySize\`Optional +##### \`memorySize\`Optional \`\`\`java public java.lang.Number getMemorySize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. @@ -2367,58 +2365,58 @@ Lambda uses this value to proportionally allocate the amount of CPU power. For m --- -##### \`profiling\`Optional +##### \`profiling\`Optional \`\`\`java public java.lang.Boolean getProfiling(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* No profiling. Enable profiling. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`profilingGroup\`Optional +##### \`profilingGroup\`Optional \`\`\`java public IProfilingGroup getProfilingGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup\`](#software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup) +- *Type:* software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if \`profiling\` is set. Profiling Group. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`reservedConcurrentExecutions\`Optional +##### \`reservedConcurrentExecutions\`Optional \`\`\`java public java.lang.Number getReservedConcurrentExecutions(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. -> https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html +> [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling \`addToRolePolicy\`. Lambda execution role. @@ -2427,7 +2425,7 @@ This is the role that will be assumed by the function upon execution. It control --- -##### ~~\`securityGroup\`~~Optional +##### ~~\`securityGroup\`~~Optional - *Deprecated:* - This property is deprecated, use securityGroups instead @@ -2435,7 +2433,7 @@ This is the role that will be assumed by the function upon execution. It control public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function. What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. @@ -2444,13 +2442,13 @@ Only used if 'vpc' is supplied. Use securityGroups property instead. Function c --- -##### \`securityGroups\`Optional +##### \`securityGroups\`Optional \`\`\`java public java.util.List getSecurityGroups(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> +- *Type:* java.util.List - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. @@ -2459,13 +2457,13 @@ Only used if 'vpc' is supplied. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. @@ -2474,26 +2472,26 @@ Because the execution time affects cost, set this value based on the function's --- -##### \`tracing\`Optional +##### \`tracing\`Optional \`\`\`java public Tracing getTracing(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.Tracing\`](#software.amazon.awscdk.services.lambda.Tracing) +- *Type:* software.amazon.awscdk.services.lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. @@ -2502,13 +2500,13 @@ Specify this if the Lambda function needs to access resources in a VPC. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public SubnetSelection getVpcSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. @@ -2517,13 +2515,13 @@ Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT --- -##### \`code\`Required +##### \`code\`Required \`\`\`java public Code getCode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.Code\`](#software.amazon.awscdk.services.lambda.Code) +- *Type:* software.amazon.awscdk.services.lambda.Code The source code of your Lambda function. @@ -2531,13 +2529,13 @@ You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket o --- -##### \`handler\`Required +##### \`handler\`Required \`\`\`java public java.lang.String getHandler(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the method within your code that Lambda calls to execute your function. @@ -2545,13 +2543,13 @@ The format includes the file name. It can also include namespaces and other qual --- -##### \`runtime\`Required +##### \`runtime\`Required \`\`\`java public Runtime getRuntime(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.Runtime\`](#software.amazon.awscdk.services.lambda.Runtime) +- *Type:* software.amazon.awscdk.services.lambda.Runtime The runtime environment for the Lambda function that you are uploading. @@ -2559,13 +2557,13 @@ For valid values, see the Runtime property in the AWS Lambda Developer Guide. U --- -##### \`stackId\`Optional +##### \`stackId\`Optional \`\`\`java public java.lang.String getStackId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \`edge-lambda-stack-\${region}\` The stack ID of Lambda@Edge function. @@ -2578,20 +2576,19 @@ The stack ID of Lambda@Edge function. `; exports[`submodules without an explicit name python 1`] = ` -" -# API Reference +"# API Reference -## Constructs +## Constructs -### EdgeFunction +### EdgeFunction -- *Implements:* [\`aws_cdk.aws_lambda.IVersion\`](#aws_cdk.aws_lambda.IVersion) +- *Implements:* aws_cdk.aws_lambda.IVersion A Lambda@Edge function. Convenience resource for requesting a Lambda function in the 'us-east-1' region for use with Lambda@Edge. Implements several restrictions enforced by Lambda@Edge. Note that this construct requires that the 'us-east-1' region has been bootstrapped. See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html or 'cdk bootstrap --help' for options. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_cloudfront @@ -2642,64 +2639,64 @@ experimental.EdgeFunction( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkexperimentaledgefunctionparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkexperimentaledgefunctionparameterid)* | \`str\` | *No description.* | -| [\`max_event_age\`](#awscdkexperimentaledgefunctionpropsparametermaxeventage) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The maximum age of a request that Lambda sends to a function for processing. | -| [\`on_failure\`](#awscdkexperimentaledgefunctionpropsparameteronfailure) | [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) | The destination for failed invocations. | -| [\`on_success\`](#awscdkexperimentaledgefunctionpropsparameteronsuccess) | [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) | The destination for successful invocations. | -| [\`retry_attempts\`](#awscdkexperimentaledgefunctionpropsparameterretryattempts) | \`typing.Union[int, float]\` | The maximum number of times to retry when the function returns an error. | -| [\`allow_all_outbound\`](#awscdkexperimentaledgefunctionpropsparameterallowalloutbound) | \`bool\` | Whether to allow the Lambda to send all network traffic. | -| [\`allow_public_subnet\`](#awscdkexperimentaledgefunctionpropsparameterallowpublicsubnet) | \`bool\` | Lambda Functions in a public subnet can NOT access the internet. | -| [\`architectures\`](#awscdkexperimentaledgefunctionpropsparameterarchitectures) | typing.List[[\`aws_cdk.aws_lambda.Architecture\`](#aws_cdk.aws_lambda.Architecture)] | The system architectures compatible with this lambda function. | -| [\`code_signing_config\`](#awscdkexperimentaledgefunctionpropsparametercodesigningconfig) | [\`aws_cdk.aws_lambda.ICodeSigningConfig\`](#aws_cdk.aws_lambda.ICodeSigningConfig) | Code signing config associated with this function. | -| [\`current_version_options\`](#awscdkexperimentaledgefunctionpropsparametercurrentversionoptions) | [\`aws_cdk.aws_lambda.VersionOptions\`](#aws_cdk.aws_lambda.VersionOptions) | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | -| [\`dead_letter_queue\`](#awscdkexperimentaledgefunctionpropsparameterdeadletterqueue) | [\`aws_cdk.aws_sqs.IQueue\`](#aws_cdk.aws_sqs.IQueue) | The SQS queue to use if DLQ is enabled. | -| [\`dead_letter_queue_enabled\`](#awscdkexperimentaledgefunctionpropsparameterdeadletterqueueenabled) | \`bool\` | Enabled DLQ. | -| [\`description\`](#awscdkexperimentaledgefunctionpropsparameterdescription) | \`str\` | A description of the function. | -| [\`environment\`](#awscdkexperimentaledgefunctionpropsparameterenvironment) | typing.Mapping[\`str\`] | Key-value pairs that Lambda caches and makes available for your Lambda functions. | -| [\`environment_encryption\`](#awscdkexperimentaledgefunctionpropsparameterenvironmentencryption) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | The AWS KMS key that's used to encrypt your function's environment variables. | -| [\`events\`](#awscdkexperimentaledgefunctionpropsparameterevents) | typing.List[[\`aws_cdk.aws_lambda.IEventSource\`](#aws_cdk.aws_lambda.IEventSource)] | Event sources for this function. | -| [\`filesystem\`](#awscdkexperimentaledgefunctionpropsparameterfilesystem) | [\`aws_cdk.aws_lambda.FileSystem\`](#aws_cdk.aws_lambda.FileSystem) | The filesystem configuration for the lambda function. | -| [\`function_name\`](#awscdkexperimentaledgefunctionpropsparameterfunctionname) | \`str\` | A name for the function. | -| [\`initial_policy\`](#awscdkexperimentaledgefunctionpropsparameterinitialpolicy) | typing.List[[\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement)] | Initial policy statements to add to the created Lambda Role. | -| [\`insights_version\`](#awscdkexperimentaledgefunctionpropsparameterinsightsversion) | [\`aws_cdk.aws_lambda.LambdaInsightsVersion\`](#aws_cdk.aws_lambda.LambdaInsightsVersion) | Specify the version of CloudWatch Lambda insights to use for monitoring. | -| [\`layers\`](#awscdkexperimentaledgefunctionpropsparameterlayers) | typing.List[[\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion)] | A list of layers to add to the function's execution environment. | -| [\`log_retention\`](#awscdkexperimentaledgefunctionpropsparameterlogretention) | [\`aws_cdk.aws_logs.RetentionDays\`](#aws_cdk.aws_logs.RetentionDays) | The number of days log events are kept in CloudWatch Logs. | -| [\`log_retention_retry_options\`](#awscdkexperimentaledgefunctionpropsparameterlogretentionretryoptions) | [\`aws_cdk.aws_lambda.LogRetentionRetryOptions\`](#aws_cdk.aws_lambda.LogRetentionRetryOptions) | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | -| [\`log_retention_role\`](#awscdkexperimentaledgefunctionpropsparameterlogretentionrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | -| [\`memory_size\`](#awscdkexperimentaledgefunctionpropsparametermemorysize) | \`typing.Union[int, float]\` | The amount of memory, in MB, that is allocated to your Lambda function. | -| [\`profiling\`](#awscdkexperimentaledgefunctionpropsparameterprofiling) | \`bool\` | Enable profiling. | -| [\`profiling_group\`](#awscdkexperimentaledgefunctionpropsparameterprofilinggroup) | [\`aws_cdk.aws_codeguruprofiler.IProfilingGroup\`](#aws_cdk.aws_codeguruprofiler.IProfilingGroup) | Profiling Group. | -| [\`reserved_concurrent_executions\`](#awscdkexperimentaledgefunctionpropsparameterreservedconcurrentexecutions) | \`typing.Union[int, float]\` | The maximum of concurrent executions you want to reserve for the function. | -| [\`role\`](#awscdkexperimentaledgefunctionpropsparameterrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Lambda execution role. | -| [\`security_group\`](#awscdkexperimentaledgefunctionpropsparametersecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | -| [\`security_groups\`](#awscdkexperimentaledgefunctionpropsparametersecuritygroups) | typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] | The list of security groups to associate with the Lambda's network interfaces. | -| [\`timeout\`](#awscdkexperimentaledgefunctionpropsparametertimeout) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The function execution time (in seconds) after which Lambda terminates the function. | -| [\`tracing\`](#awscdkexperimentaledgefunctionpropsparametertracing) | [\`aws_cdk.aws_lambda.Tracing\`](#aws_cdk.aws_lambda.Tracing) | Enable AWS X-Ray Tracing for Lambda Function. | -| [\`vpc\`](#awscdkexperimentaledgefunctionpropsparametervpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | VPC network to place Lambda network interfaces. | -| [\`vpc_subnets\`](#awscdkexperimentaledgefunctionpropsparametervpcsubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Where to place the network interfaces within the VPC. | -| [\`code\`](#awscdkexperimentaledgefunctionpropsparametercode)* | [\`aws_cdk.aws_lambda.Code\`](#aws_cdk.aws_lambda.Code) | The source code of your Lambda function. | -| [\`handler\`](#awscdkexperimentaledgefunctionpropsparameterhandler)* | \`str\` | The name of the method within your code that Lambda calls to execute your function. | -| [\`runtime\`](#awscdkexperimentaledgefunctionpropsparameterruntime)* | [\`aws_cdk.aws_lambda.Runtime\`](#aws_cdk.aws_lambda.Runtime) | The runtime environment for the Lambda function that you are uploading. | -| [\`stack_id\`](#awscdkexperimentaledgefunctionpropsparameterstackid) | \`str\` | The stack ID of Lambda@Edge function. | - ---- - -##### \`scope\`Required - -- *Type:* [\`constructs.Construct\`](#constructs.Construct) - ---- - -##### \`id\`Required - -- *Type:* \`str\` - ---- - -##### \`max_event_age\`Optional - -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| max_event_age | aws_cdk.core.Duration | The maximum age of a request that Lambda sends to a function for processing. | +| on_failure | aws_cdk.aws_lambda.IDestination | The destination for failed invocations. | +| on_success | aws_cdk.aws_lambda.IDestination | The destination for successful invocations. | +| retry_attempts | typing.Union[int, float] | The maximum number of times to retry when the function returns an error. | +| allow_all_outbound | bool | Whether to allow the Lambda to send all network traffic. | +| allow_public_subnet | bool | Lambda Functions in a public subnet can NOT access the internet. | +| architectures | typing.List[aws_cdk.aws_lambda.Architecture] | The system architectures compatible with this lambda function. | +| code_signing_config | aws_cdk.aws_lambda.ICodeSigningConfig | Code signing config associated with this function. | +| current_version_options | aws_cdk.aws_lambda.VersionOptions | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | +| dead_letter_queue | aws_cdk.aws_sqs.IQueue | The SQS queue to use if DLQ is enabled. | +| dead_letter_queue_enabled | bool | Enabled DLQ. | +| description | str | A description of the function. | +| environment | typing.Mapping[str] | Key-value pairs that Lambda caches and makes available for your Lambda functions. | +| environment_encryption | aws_cdk.aws_kms.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | +| events | typing.List[aws_cdk.aws_lambda.IEventSource] | Event sources for this function. | +| filesystem | aws_cdk.aws_lambda.FileSystem | The filesystem configuration for the lambda function. | +| function_name | str | A name for the function. | +| initial_policy | typing.List[aws_cdk.aws_iam.PolicyStatement] | Initial policy statements to add to the created Lambda Role. | +| insights_version | aws_cdk.aws_lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | +| layers | typing.List[aws_cdk.aws_lambda.ILayerVersion] | A list of layers to add to the function's execution environment. | +| log_retention | aws_cdk.aws_logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | +| log_retention_retry_options | aws_cdk.aws_lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | +| log_retention_role | aws_cdk.aws_iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | +| memory_size | typing.Union[int, float] | The amount of memory, in MB, that is allocated to your Lambda function. | +| profiling | bool | Enable profiling. | +| profiling_group | aws_cdk.aws_codeguruprofiler.IProfilingGroup | Profiling Group. | +| reserved_concurrent_executions | typing.Union[int, float] | The maximum of concurrent executions you want to reserve for the function. | +| role | aws_cdk.aws_iam.IRole | Lambda execution role. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | +| security_groups | typing.List[aws_cdk.aws_ec2.ISecurityGroup] | The list of security groups to associate with the Lambda's network interfaces. | +| timeout | aws_cdk.core.Duration | The function execution time (in seconds) after which Lambda terminates the function. | +| tracing | aws_cdk.aws_lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | +| vpc | aws_cdk.aws_ec2.IVpc | VPC network to place Lambda network interfaces. | +| vpc_subnets | aws_cdk.aws_ec2.SubnetSelection | Where to place the network interfaces within the VPC. | +| code | aws_cdk.aws_lambda.Code | The source code of your Lambda function. | +| handler | str | The name of the method within your code that Lambda calls to execute your function. | +| runtime | aws_cdk.aws_lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | +| stack_id | str | The stack ID of Lambda@Edge function. | + +--- + +##### \`scope\`Required + +- *Type:* constructs.Construct + +--- + +##### \`id\`Required + +- *Type:* str + +--- + +##### \`max_event_age\`Optional + +- *Type:* aws_cdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -2708,27 +2705,27 @@ Minimum: 60 seconds Maximum: 6 hours --- -##### \`on_failure\`Optional +##### \`on_failure\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -##### \`on_success\`Optional +##### \`on_success\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -##### \`retry_attempts\`Optional +##### \`retry_attempts\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -2737,9 +2734,9 @@ Minimum: 0 Maximum: 2 --- -##### \`allow_all_outbound\`Optional +##### \`allow_all_outbound\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether to allow the Lambda to send all network traffic. @@ -2748,58 +2745,58 @@ If set to false, you must individually add traffic rules to allow the Lambda to --- -##### \`allow_public_subnet\`Optional +##### \`allow_public_subnet\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. -> https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841 +> [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- -##### \`architectures\`Optional +##### \`architectures\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_lambda.Architecture\`](#aws_cdk.aws_lambda.Architecture)] +- *Type:* typing.List[aws_cdk.aws_lambda.Architecture] - *Default:* [Architecture.X86_64] The system architectures compatible with this lambda function. --- -##### \`code_signing_config\`Optional +##### \`code_signing_config\`Optional -- *Type:* [\`aws_cdk.aws_lambda.ICodeSigningConfig\`](#aws_cdk.aws_lambda.ICodeSigningConfig) +- *Type:* aws_cdk.aws_lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- -##### \`current_version_options\`Optional +##### \`current_version_options\`Optional -- *Type:* [\`aws_cdk.aws_lambda.VersionOptions\`](#aws_cdk.aws_lambda.VersionOptions) +- *Type:* aws_cdk.aws_lambda.VersionOptions - *Default:* default options as described in \`VersionOptions\` Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. --- -##### \`dead_letter_queue\`Optional +##### \`dead_letter_queue\`Optional -- *Type:* [\`aws_cdk.aws_sqs.IQueue\`](#aws_cdk.aws_sqs.IQueue) +- *Type:* aws_cdk.aws_sqs.IQueue - *Default:* SQS queue with 14 day retention period if \`deadLetterQueueEnabled\` is \`true\` The SQS queue to use if DLQ is enabled. --- -##### \`dead_letter_queue_enabled\`Optional +##### \`dead_letter_queue_enabled\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false unless \`deadLetterQueue\` is set, which implies DLQ is enabled. Enabled DLQ. @@ -2808,18 +2805,18 @@ If \`deadLetterQueue\` is undefined, an SQS queue with default options will be d --- -##### \`description\`Optional +##### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description. A description of the function. --- -##### \`environment\`Optional +##### \`environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. @@ -2828,18 +2825,18 @@ Use environment variables to apply configuration changes, such as test and produ --- -##### \`environment_encryption\`Optional +##### \`environment_encryption\`Optional -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- -##### \`events\`Optional +##### \`events\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_lambda.IEventSource\`](#aws_cdk.aws_lambda.IEventSource)] +- *Type:* typing.List[aws_cdk.aws_lambda.IEventSource] - *Default:* No event sources. Event sources for this function. @@ -2848,27 +2845,27 @@ You can also add event sources using \`addEventSource\`. --- -##### \`filesystem\`Optional +##### \`filesystem\`Optional -- *Type:* [\`aws_cdk.aws_lambda.FileSystem\`](#aws_cdk.aws_lambda.FileSystem) +- *Type:* aws_cdk.aws_lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- -##### \`function_name\`Optional +##### \`function_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- -##### \`initial_policy\`Optional +##### \`initial_policy\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement)] +- *Type:* typing.List[aws_cdk.aws_iam.PolicyStatement] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. @@ -2877,20 +2874,20 @@ You can call \`addToRolePolicy\` to the created lambda to add statements post cr --- -##### \`insights_version\`Optional +##### \`insights_version\`Optional -- *Type:* [\`aws_cdk.aws_lambda.LambdaInsightsVersion\`](#aws_cdk.aws_lambda.LambdaInsightsVersion) +- *Type:* aws_cdk.aws_lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. -> https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html +> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html) --- -##### \`layers\`Optional +##### \`layers\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion)] +- *Type:* typing.List[aws_cdk.aws_lambda.ILayerVersion] - *Default:* No layers. A list of layers to add to the function's execution environment. @@ -2899,9 +2896,9 @@ You can configure your Lambda function to pull in additional code during initial --- -##### \`log_retention\`Optional +##### \`log_retention\`Optional -- *Type:* [\`aws_cdk.aws_logs.RetentionDays\`](#aws_cdk.aws_logs.RetentionDays) +- *Type:* aws_cdk.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. @@ -2910,9 +2907,9 @@ When updating this property, unsetting it doesn't remove the log retention polic --- -##### \`log_retention_retry_options\`Optional +##### \`log_retention_retry_options\`Optional -- *Type:* [\`aws_cdk.aws_lambda.LogRetentionRetryOptions\`](#aws_cdk.aws_lambda.LogRetentionRetryOptions) +- *Type:* aws_cdk.aws_lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. @@ -2921,18 +2918,18 @@ These options control the retry policy when interacting with CloudWatch APIs. --- -##### \`log_retention_role\`Optional +##### \`log_retention_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. --- -##### \`memory_size\`Optional +##### \`memory_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. @@ -2941,42 +2938,42 @@ Lambda uses this value to proportionally allocate the amount of CPU power. For m --- -##### \`profiling\`Optional +##### \`profiling\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* No profiling. Enable profiling. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`profiling_group\`Optional +##### \`profiling_group\`Optional -- *Type:* [\`aws_cdk.aws_codeguruprofiler.IProfilingGroup\`](#aws_cdk.aws_codeguruprofiler.IProfilingGroup) +- *Type:* aws_cdk.aws_codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if \`profiling\` is set. Profiling Group. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`reserved_concurrent_executions\`Optional +##### \`reserved_concurrent_executions\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. -> https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html +> [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling \`addToRolePolicy\`. Lambda execution role. @@ -2985,11 +2982,11 @@ This is the role that will be assumed by the function upon execution. It control --- -##### ~~\`security_group\`~~Optional +##### ~~\`security_group\`~~Optional - *Deprecated:* - This property is deprecated, use securityGroups instead -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function. What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. @@ -2998,9 +2995,9 @@ Only used if 'vpc' is supplied. Use securityGroups property instead. Function c --- -##### \`security_groups\`Optional +##### \`security_groups\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] +- *Type:* typing.List[aws_cdk.aws_ec2.ISecurityGroup] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. @@ -3009,9 +3006,9 @@ Only used if 'vpc' is supplied. --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. @@ -3020,18 +3017,18 @@ Because the execution time affects cost, set this value based on the function's --- -##### \`tracing\`Optional +##### \`tracing\`Optional -- *Type:* [\`aws_cdk.aws_lambda.Tracing\`](#aws_cdk.aws_lambda.Tracing) +- *Type:* aws_cdk.aws_lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. @@ -3040,9 +3037,9 @@ Specify this if the Lambda function needs to access resources in a VPC. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. @@ -3051,9 +3048,9 @@ Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT --- -##### \`code\`Required +##### \`code\`Required -- *Type:* [\`aws_cdk.aws_lambda.Code\`](#aws_cdk.aws_lambda.Code) +- *Type:* aws_cdk.aws_lambda.Code The source code of your Lambda function. @@ -3061,9 +3058,9 @@ You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket o --- -##### \`handler\`Required +##### \`handler\`Required -- *Type:* \`str\` +- *Type:* str The name of the method within your code that Lambda calls to execute your function. @@ -3071,9 +3068,9 @@ The format includes the file name. It can also include namespaces and other qual --- -##### \`runtime\`Required +##### \`runtime\`Required -- *Type:* [\`aws_cdk.aws_lambda.Runtime\`](#aws_cdk.aws_lambda.Runtime) +- *Type:* aws_cdk.aws_lambda.Runtime The runtime environment for the Lambda function that you are uploading. @@ -3081,35 +3078,35 @@ For valid values, see the Runtime property in the AWS Lambda Developer Guide. U --- -##### \`stack_id\`Optional +##### \`stack_id\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* \`edge-lambda-stack-\${region}\` The stack ID of Lambda@Edge function. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_alias\`](#awscdkexperimentaledgefunctionaddalias) | Defines an alias for this version. | -| [\`add_event_source\`](#awscdkexperimentaledgefunctionaddeventsource) | Adds an event source to this function. | -| [\`add_event_source_mapping\`](#awscdkexperimentaledgefunctionaddeventsourcemapping) | Adds an event source that maps to this AWS Lambda function. | -| [\`add_permission\`](#awscdkexperimentaledgefunctionaddpermission) | Adds a permission to the Lambda resource policy. | -| [\`add_to_role_policy\`](#awscdkexperimentaledgefunctionaddtorolepolicy) | Adds a statement to the IAM role assumed by the instance. | -| [\`configure_async_invoke\`](#awscdkexperimentaledgefunctionconfigureasyncinvoke) | Configures options for asynchronous invocation. | -| [\`grant_invoke\`](#awscdkexperimentaledgefunctiongrantinvoke) | Grant the given identity permissions to invoke this Lambda. | -| [\`metric\`](#awscdkexperimentaledgefunctionmetric) | Return the given named metric for this Lambda Return the given named metric for this Function. | -| [\`metric_duration\`](#awscdkexperimentaledgefunctionmetricduration) | Metric for the Duration of this Lambda How long execution of this Lambda takes. | -| [\`metric_errors\`](#awscdkexperimentaledgefunctionmetricerrors) | How many invocations of this Lambda fail. | -| [\`metric_invocations\`](#awscdkexperimentaledgefunctionmetricinvocations) | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | -| [\`metric_throttles\`](#awscdkexperimentaledgefunctionmetricthrottles) | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | +| add_alias | Defines an alias for this version. | +| add_event_source | Adds an event source to this function. | +| add_event_source_mapping | Adds an event source that maps to this AWS Lambda function. | +| add_permission | Adds a permission to the Lambda resource policy. | +| add_to_role_policy | Adds a statement to the IAM role assumed by the instance. | +| configure_async_invoke | Configures options for asynchronous invocation. | +| grant_invoke | Grant the given identity permissions to invoke this Lambda. | +| metric | Return the given named metric for this Lambda Return the given named metric for this Function. | +| metric_duration | Metric for the Duration of this Lambda How long execution of this Lambda takes. | +| metric_errors | How many invocations of this Lambda fail. | +| metric_invocations | Metric for the number of invocations of this Lambda How often this Lambda is invoked. | +| metric_throttles | Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled. | --- -##### \`add_alias\` +##### \`add_alias\` \`\`\`python def add_alias( @@ -3124,15 +3121,15 @@ def add_alias( ) \`\`\` -###### \`alias_name\`Required +###### \`alias_name\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`max_event_age\`Optional +###### \`max_event_age\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -3141,27 +3138,27 @@ Minimum: 60 seconds Maximum: 6 hours --- -###### \`on_failure\`Optional +###### \`on_failure\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -###### \`on_success\`Optional +###### \`on_success\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -###### \`retry_attempts\`Optional +###### \`retry_attempts\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -3170,9 +3167,9 @@ Minimum: 0 Maximum: 2 --- -###### \`additional_versions\`Optional +###### \`additional_versions\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_lambda.VersionWeight\`](#aws_cdk.aws_lambda.VersionWeight)] +- *Type:* typing.List[aws_cdk.aws_lambda.VersionWeight] - *Default:* No additional versions Additional versions with individual weights this alias points to. @@ -3181,25 +3178,25 @@ Individual additional version weights specified here should add up to (less than --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description Description for the alias. --- -###### \`provisioned_concurrent_executions\`Optional +###### \`provisioned_concurrent_executions\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* No provisioned concurrency Specifies a provisioned concurrency configuration for a function's alias. --- -##### \`add_event_source\` +##### \`add_event_source\` \`\`\`python def add_event_source( @@ -3207,13 +3204,13 @@ def add_event_source( ) \`\`\` -###### \`source\`Required +###### \`source\`Required -- *Type:* [\`aws_cdk.aws_lambda.IEventSource\`](#aws_cdk.aws_lambda.IEventSource) +- *Type:* aws_cdk.aws_lambda.IEventSource --- -##### \`add_event_source_mapping\` +##### \`add_event_source_mapping\` \`\`\`python def add_event_source_mapping( @@ -3236,15 +3233,15 @@ def add_event_source_mapping( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`batch_size\`Optional +###### \`batch_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. Both the default and maximum for Amazon SQS are 10 messages. The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. @@ -3253,27 +3250,27 @@ Your function receives an event with all the retrieved records. Valid Range: Mi --- -###### \`bisect_batch_on_error\`Optional +###### \`bisect_batch_on_error\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If the function returns an error, split the batch in two and retry. --- -###### \`enabled\`Optional +###### \`enabled\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Set to false to disable the event source upon creation. --- -###### \`event_source_arn\`Optional +###### \`event_source_arn\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* not set if using a self managed Kafka cluster, throws an error otherwise The Amazon Resource Name (ARN) of the event source. @@ -3282,9 +3279,9 @@ Any record added to this stream can invoke the Lambda function. --- -###### \`kafka_bootstrap_servers\`Optional +###### \`kafka_bootstrap_servers\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* none A list of host and port pairs that are the addresses of the Kafka brokers in a self managed \\"bootstrap\\" Kafka cluster that a Kafka client connects to initially to bootstrap itself. @@ -3293,18 +3290,18 @@ They are in the format \`abc.example.com:9096\`. --- -###### \`kafka_topic\`Optional +###### \`kafka_topic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* no topic The name of the Kafka topic. --- -###### \`max_batching_window\`Optional +###### \`max_batching_window\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.seconds(0) The maximum amount of time to gather records before invoking the function. @@ -3313,9 +3310,9 @@ Maximum of Duration.minutes(5) --- -###### \`max_record_age\`Optional +###### \`max_record_age\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* infinite or until the record expires. The maximum age of a record that Lambda sends to a function for processing. @@ -3324,18 +3321,18 @@ Valid Range: * Minimum value of 60 seconds * Maximum value of 7 days --- -###### \`on_failure\`Optional +###### \`on_failure\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IEventSourceDlq\`](#aws_cdk.aws_lambda.IEventSourceDlq) +- *Type:* aws_cdk.aws_lambda.IEventSourceDlq - *Default:* discarded records are ignored An Amazon SQS queue or Amazon SNS topic destination for discarded records. --- -###### \`parallelization_factor\`Optional +###### \`parallelization_factor\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 The number of batches to process from each shard concurrently. @@ -3344,20 +3341,20 @@ Valid Range: * Minimum value of 1 * Maximum value of 10 --- -###### \`report_batch_item_failures\`Optional +###### \`report_batch_item_failures\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Allow functions to return partially successful responses for a batch of records. -> https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting +> [https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) --- -###### \`retry_attempts\`Optional +###### \`retry_attempts\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* infinite or until the record expires. The maximum number of times to retry when the function returns an error. @@ -3366,42 +3363,44 @@ Set to \`undefined\` if you want lambda to keep retrying infinitely or until the --- -###### \`source_access_configurations\`Optional +###### \`source_access_configurations\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_lambda.SourceAccessConfiguration\`](#aws_cdk.aws_lambda.SourceAccessConfiguration)] +- *Type:* typing.List[aws_cdk.aws_lambda.SourceAccessConfiguration] - *Default:* none Specific settings like the authentication protocol or the VPC components to secure access to your event source. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html) --- -###### \`starting_position\`Optional +###### \`starting_position\`Optional -- *Type:* [\`aws_cdk.aws_lambda.StartingPosition\`](#aws_cdk.aws_lambda.StartingPosition) +- *Type:* aws_cdk.aws_lambda.StartingPosition - *Default:* Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading. -> https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType +> [https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType) --- -###### \`tumbling_window\`Optional +###### \`tumbling_window\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* None The size of the tumbling windows to group records sent to DynamoDB or Kinesis. -> https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows +> [https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows + +Valid Range: 0 - 15 minutes](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows -Valid Range: 0 - 15 minutes +Valid Range: 0 - 15 minutes) --- -##### \`add_permission\` +##### \`add_permission\` \`\`\`python def add_permission( @@ -3415,15 +3414,15 @@ def add_permission( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`principal\`Required +###### \`principal\`Required -- *Type:* [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) +- *Type:* aws_cdk.aws_iam.IPrincipal The entity for which you are granting permission to invoke the Lambda function. @@ -3431,9 +3430,9 @@ This entity can be any valid AWS service principal, such as s3.amazonaws.com or --- -###### \`action\`Optional +###### \`action\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* 'lambda:InvokeFunction' The Lambda actions that you want to allow in this statement. @@ -3442,18 +3441,18 @@ For example, you can specify lambda:CreateFunction to specify a certain action, --- -###### \`event_source_token\`Optional +###### \`event_source_token\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The caller would not need to present a token. A unique token that must be supplied by the principal invoking the function. --- -###### \`scope\`Optional +###### \`scope\`Optional -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct - *Default:* The instance of lambda.IFunction The scope to which the permission constructs be attached. @@ -3462,9 +3461,9 @@ The default is the Lambda function construct itself, but this would need to be d --- -###### \`source_account\`Optional +###### \`source_account\`Optional -- *Type:* \`str\` +- *Type:* str The AWS account ID (without hyphens) of the source owner. @@ -3472,9 +3471,9 @@ For example, if you specify an S3 bucket in the SourceArn property, this value i --- -###### \`source_arn\`Optional +###### \`source_arn\`Optional -- *Type:* \`str\` +- *Type:* str The ARN of a resource that is invoking your function. @@ -3482,7 +3481,7 @@ When granting Amazon Simple Storage Service (Amazon S3) permission to invoke you --- -##### \`add_to_role_policy\` +##### \`add_to_role_policy\` \`\`\`python def add_to_role_policy( @@ -3490,13 +3489,13 @@ def add_to_role_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -##### \`configure_async_invoke\` +##### \`configure_async_invoke\` \`\`\`python def configure_async_invoke( @@ -3507,9 +3506,9 @@ def configure_async_invoke( ) \`\`\` -###### \`max_event_age\`Optional +###### \`max_event_age\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -3518,27 +3517,27 @@ Minimum: 60 seconds Maximum: 6 hours --- -###### \`on_failure\`Optional +###### \`on_failure\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -###### \`on_success\`Optional +###### \`on_success\`Optional -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -###### \`retry_attempts\`Optional +###### \`retry_attempts\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -3547,7 +3546,7 @@ Minimum: 0 Maximum: 2 --- -##### \`grant_invoke\` +##### \`grant_invoke\` \`\`\`python def grant_invoke( @@ -3555,13 +3554,13 @@ def grant_invoke( ) \`\`\` -###### \`identity\`Required +###### \`identity\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`metric\` +##### \`metric\` \`\`\`python def metric( @@ -3578,80 +3577,80 @@ def metric( ) \`\`\` -###### \`metric_name\`Required +###### \`metric_name\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment account. Account which this metric comes from. --- -###### \`color\`Optional +###### \`color\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatic color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The \`Color\` class has a set of standard colors that can be used here. --- -###### ~~\`dimensions\`~~Optional +###### ~~\`dimensions\`~~Optional - *Deprecated:* Use 'dimensionsMap' instead. -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`dimensions_map\`Optional +###### \`dimensions_map\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`label\`Optional +###### \`label\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No label Label for this metric when added to a Graph in a Dashboard. --- -###### \`period\`Optional +###### \`period\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- -###### \`region\`Optional +###### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment region. Region which this metric comes from. --- -###### \`statistic\`Optional +###### \`statistic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Average What function to use for aggregating. @@ -3660,9 +3659,9 @@ Can be one of the following: - \\"Minimum\\" | \\"min\\" - \\"Maximum\\" | \\"m --- -###### \`unit\`Optional +###### \`unit\`Optional -- *Type:* [\`aws_cdk.aws_cloudwatch.Unit\`](#aws_cdk.aws_cloudwatch.Unit) +- *Type:* aws_cdk.aws_cloudwatch.Unit - *Default:* All metric datums in the given metric stream Unit used to filter the metric stream. @@ -3671,7 +3670,7 @@ Only refer to datums emitted to the metric stream with the given unit and ignore --- -##### \`metric_duration\` +##### \`metric_duration\` \`\`\`python def metric_duration( @@ -3687,74 +3686,74 @@ def metric_duration( ) \`\`\` -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment account. Account which this metric comes from. --- -###### \`color\`Optional +###### \`color\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatic color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The \`Color\` class has a set of standard colors that can be used here. --- -###### ~~\`dimensions\`~~Optional +###### ~~\`dimensions\`~~Optional - *Deprecated:* Use 'dimensionsMap' instead. -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`dimensions_map\`Optional +###### \`dimensions_map\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`label\`Optional +###### \`label\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No label Label for this metric when added to a Graph in a Dashboard. --- -###### \`period\`Optional +###### \`period\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- -###### \`region\`Optional +###### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment region. Region which this metric comes from. --- -###### \`statistic\`Optional +###### \`statistic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Average What function to use for aggregating. @@ -3763,9 +3762,9 @@ Can be one of the following: - \\"Minimum\\" | \\"min\\" - \\"Maximum\\" | \\"m --- -###### \`unit\`Optional +###### \`unit\`Optional -- *Type:* [\`aws_cdk.aws_cloudwatch.Unit\`](#aws_cdk.aws_cloudwatch.Unit) +- *Type:* aws_cdk.aws_cloudwatch.Unit - *Default:* All metric datums in the given metric stream Unit used to filter the metric stream. @@ -3774,7 +3773,7 @@ Only refer to datums emitted to the metric stream with the given unit and ignore --- -##### \`metric_errors\` +##### \`metric_errors\` \`\`\`python def metric_errors( @@ -3790,74 +3789,74 @@ def metric_errors( ) \`\`\` -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment account. Account which this metric comes from. --- -###### \`color\`Optional +###### \`color\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatic color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The \`Color\` class has a set of standard colors that can be used here. --- -###### ~~\`dimensions\`~~Optional +###### ~~\`dimensions\`~~Optional - *Deprecated:* Use 'dimensionsMap' instead. -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`dimensions_map\`Optional +###### \`dimensions_map\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`label\`Optional +###### \`label\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No label Label for this metric when added to a Graph in a Dashboard. --- -###### \`period\`Optional +###### \`period\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- -###### \`region\`Optional +###### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment region. Region which this metric comes from. --- -###### \`statistic\`Optional +###### \`statistic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Average What function to use for aggregating. @@ -3866,9 +3865,9 @@ Can be one of the following: - \\"Minimum\\" | \\"min\\" - \\"Maximum\\" | \\"m --- -###### \`unit\`Optional +###### \`unit\`Optional -- *Type:* [\`aws_cdk.aws_cloudwatch.Unit\`](#aws_cdk.aws_cloudwatch.Unit) +- *Type:* aws_cdk.aws_cloudwatch.Unit - *Default:* All metric datums in the given metric stream Unit used to filter the metric stream. @@ -3877,7 +3876,7 @@ Only refer to datums emitted to the metric stream with the given unit and ignore --- -##### \`metric_invocations\` +##### \`metric_invocations\` \`\`\`python def metric_invocations( @@ -3893,74 +3892,74 @@ def metric_invocations( ) \`\`\` -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment account. Account which this metric comes from. --- -###### \`color\`Optional +###### \`color\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatic color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The \`Color\` class has a set of standard colors that can be used here. --- -###### ~~\`dimensions\`~~Optional +###### ~~\`dimensions\`~~Optional - *Deprecated:* Use 'dimensionsMap' instead. -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`dimensions_map\`Optional +###### \`dimensions_map\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`label\`Optional +###### \`label\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No label Label for this metric when added to a Graph in a Dashboard. --- -###### \`period\`Optional +###### \`period\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- -###### \`region\`Optional +###### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment region. Region which this metric comes from. --- -###### \`statistic\`Optional +###### \`statistic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Average What function to use for aggregating. @@ -3969,9 +3968,9 @@ Can be one of the following: - \\"Minimum\\" | \\"min\\" - \\"Maximum\\" | \\"m --- -###### \`unit\`Optional +###### \`unit\`Optional -- *Type:* [\`aws_cdk.aws_cloudwatch.Unit\`](#aws_cdk.aws_cloudwatch.Unit) +- *Type:* aws_cdk.aws_cloudwatch.Unit - *Default:* All metric datums in the given metric stream Unit used to filter the metric stream. @@ -3980,7 +3979,7 @@ Only refer to datums emitted to the metric stream with the given unit and ignore --- -##### \`metric_throttles\` +##### \`metric_throttles\` \`\`\`python def metric_throttles( @@ -3996,74 +3995,74 @@ def metric_throttles( ) \`\`\` -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment account. Account which this metric comes from. --- -###### \`color\`Optional +###### \`color\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatic color The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The \`Color\` class has a set of standard colors that can be used here. --- -###### ~~\`dimensions\`~~Optional +###### ~~\`dimensions\`~~Optional - *Deprecated:* Use 'dimensionsMap' instead. -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`dimensions_map\`Optional +###### \`dimensions_map\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No dimensions. Dimensions of the metric. --- -###### \`label\`Optional +###### \`label\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No label Label for this metric when added to a Graph in a Dashboard. --- -###### \`period\`Optional +###### \`period\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- -###### \`region\`Optional +###### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Deployment region. Region which this metric comes from. --- -###### \`statistic\`Optional +###### \`statistic\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Average What function to use for aggregating. @@ -4072,9 +4071,9 @@ Can be one of the following: - \\"Minimum\\" | \\"min\\" - \\"Maximum\\" | \\"m --- -###### \`unit\`Optional +###### \`unit\`Optional -- *Type:* [\`aws_cdk.aws_cloudwatch.Unit\`](#aws_cdk.aws_cloudwatch.Unit) +- *Type:* aws_cdk.aws_cloudwatch.Unit - *Default:* All metric datums in the given metric stream Unit used to filter the metric stream. @@ -4084,32 +4083,32 @@ Only refer to datums emitted to the metric stream with the given unit and ignore --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`connections\`](#awscdkexperimentaledgefunctionpropertyconnections)* | [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) | Not supported. | -| [\`current_version\`](#awscdkexperimentaledgefunctionpropertycurrentversion)* | [\`aws_cdk.aws_lambda.IVersion\`](#aws_cdk.aws_lambda.IVersion) | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | -| [\`edge_arn\`](#awscdkexperimentaledgefunctionpropertyedgearn)* | \`str\` | The ARN of the version for Lambda@Edge. | -| [\`function_arn\`](#awscdkexperimentaledgefunctionpropertyfunctionarn)* | \`str\` | The ARN of the function. | -| [\`function_name\`](#awscdkexperimentaledgefunctionpropertyfunctionname)* | \`str\` | The name of the function. | -| [\`grant_principal\`](#awscdkexperimentaledgefunctionpropertygrantprincipal)* | [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) | The principal to grant permissions to. | -| [\`is_bound_to_vpc\`](#awscdkexperimentaledgefunctionpropertyisboundtovpc)* | \`bool\` | Whether or not this Lambda function was bound to a VPC. | -| [\`lambda\`](#awscdkexperimentaledgefunctionpropertylambda)* | [\`aws_cdk.aws_lambda.IFunction\`](#aws_cdk.aws_lambda.IFunction) | The underlying AWS Lambda function. | -| [\`latest_version\`](#awscdkexperimentaledgefunctionpropertylatestversion)* | [\`aws_cdk.aws_lambda.IVersion\`](#aws_cdk.aws_lambda.IVersion) | The \`$LATEST\` version of this function. | -| [\`permissions_node\`](#awscdkexperimentaledgefunctionpropertypermissionsnode)* | [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) | The construct node where permissions are attached. | -| [\`version\`](#awscdkexperimentaledgefunctionpropertyversion)* | \`str\` | The most recently deployed version of this function. | -| [\`role\`](#awscdkexperimentaledgefunctionpropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role associated with this function. | +| connections | aws_cdk.aws_ec2.Connections | Not supported. | +| current_version | aws_cdk.aws_lambda.IVersion | Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. | +| edge_arn | str | The ARN of the version for Lambda@Edge. | +| function_arn | str | The ARN of the function. | +| function_name | str | The name of the function. | +| grant_principal | aws_cdk.aws_iam.IPrincipal | The principal to grant permissions to. | +| is_bound_to_vpc | bool | Whether or not this Lambda function was bound to a VPC. | +| lambda | aws_cdk.aws_lambda.IFunction | The underlying AWS Lambda function. | +| latest_version | aws_cdk.aws_lambda.IVersion | The \`$LATEST\` version of this function. | +| permissions_node | aws_cdk.core.ConstructNode | The construct node where permissions are attached. | +| version | str | The most recently deployed version of this function. | +| role | aws_cdk.aws_iam.IRole | The IAM role associated with this function. | --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`python connections: Connections \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) +- *Type:* aws_cdk.aws_ec2.Connections Not supported. @@ -4117,73 +4116,73 @@ Connections are only applicable to VPC-enabled functions. --- -##### \`current_version\`Required +##### \`current_version\`Required \`\`\`python current_version: IVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.IVersion\`](#aws_cdk.aws_lambda.IVersion) +- *Type:* aws_cdk.aws_lambda.IVersion Convenience method to make \`EdgeFunction\` conform to the same interface as \`Function\`. --- -##### \`edge_arn\`Required +##### \`edge_arn\`Required \`\`\`python edge_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the version for Lambda@Edge. --- -##### \`function_arn\`Required +##### \`function_arn\`Required \`\`\`python function_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the function. --- -##### \`function_name\`Required +##### \`function_name\`Required \`\`\`python function_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the function. --- -##### \`grant_principal\`Required +##### \`grant_principal\`Required \`\`\`python grant_principal: IPrincipal \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) +- *Type:* aws_cdk.aws_iam.IPrincipal The principal to grant permissions to. --- -##### \`is_bound_to_vpc\`Required +##### \`is_bound_to_vpc\`Required \`\`\`python is_bound_to_vpc: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool Whether or not this Lambda function was bound to a VPC. @@ -4191,25 +4190,25 @@ If this is is \`false\`, trying to access the \`connections\` object will fail. --- -##### \`lambda\`Required +##### \`lambda\`Required \`\`\`python lambda: IFunction \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.IFunction\`](#aws_cdk.aws_lambda.IFunction) +- *Type:* aws_cdk.aws_lambda.IFunction The underlying AWS Lambda function. --- -##### \`latest_version\`Required +##### \`latest_version\`Required \`\`\`python latest_version: IVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.IVersion\`](#aws_cdk.aws_lambda.IVersion) +- *Type:* aws_cdk.aws_lambda.IVersion The \`$LATEST\` version of this function. @@ -4217,50 +4216,50 @@ Note that this is reference to a non-specific AWS Lambda version, which means th --- -##### \`permissions_node\`Required +##### \`permissions_node\`Required \`\`\`python permissions_node: ConstructNode \`\`\` -- *Type:* [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) +- *Type:* aws_cdk.core.ConstructNode The construct node where permissions are attached. --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str The most recently deployed version of this function. --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole The IAM role associated with this function. --- -## Structs +## Structs -### EdgeFunctionProps +### EdgeFunctionProps Properties for creating a Lambda@Edge function. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_cloudfront @@ -4307,58 +4306,58 @@ experimental.EdgeFunctionProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`max_event_age\`](#awscdkexperimentaledgefunctionpropspropertymaxeventage) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The maximum age of a request that Lambda sends to a function for processing. | -| [\`on_failure\`](#awscdkexperimentaledgefunctionpropspropertyonfailure) | [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) | The destination for failed invocations. | -| [\`on_success\`](#awscdkexperimentaledgefunctionpropspropertyonsuccess) | [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) | The destination for successful invocations. | -| [\`retry_attempts\`](#awscdkexperimentaledgefunctionpropspropertyretryattempts) | \`typing.Union[int, float]\` | The maximum number of times to retry when the function returns an error. | -| [\`allow_all_outbound\`](#awscdkexperimentaledgefunctionpropspropertyallowalloutbound) | \`bool\` | Whether to allow the Lambda to send all network traffic. | -| [\`allow_public_subnet\`](#awscdkexperimentaledgefunctionpropspropertyallowpublicsubnet) | \`bool\` | Lambda Functions in a public subnet can NOT access the internet. | -| [\`architectures\`](#awscdkexperimentaledgefunctionpropspropertyarchitectures) | typing.List[[\`aws_cdk.aws_lambda.Architecture\`](#aws_cdk.aws_lambda.Architecture)] | The system architectures compatible with this lambda function. | -| [\`code_signing_config\`](#awscdkexperimentaledgefunctionpropspropertycodesigningconfig) | [\`aws_cdk.aws_lambda.ICodeSigningConfig\`](#aws_cdk.aws_lambda.ICodeSigningConfig) | Code signing config associated with this function. | -| [\`current_version_options\`](#awscdkexperimentaledgefunctionpropspropertycurrentversionoptions) | [\`aws_cdk.aws_lambda.VersionOptions\`](#aws_cdk.aws_lambda.VersionOptions) | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | -| [\`dead_letter_queue\`](#awscdkexperimentaledgefunctionpropspropertydeadletterqueue) | [\`aws_cdk.aws_sqs.IQueue\`](#aws_cdk.aws_sqs.IQueue) | The SQS queue to use if DLQ is enabled. | -| [\`dead_letter_queue_enabled\`](#awscdkexperimentaledgefunctionpropspropertydeadletterqueueenabled) | \`bool\` | Enabled DLQ. | -| [\`description\`](#awscdkexperimentaledgefunctionpropspropertydescription) | \`str\` | A description of the function. | -| [\`environment\`](#awscdkexperimentaledgefunctionpropspropertyenvironment) | typing.Mapping[\`str\`] | Key-value pairs that Lambda caches and makes available for your Lambda functions. | -| [\`environment_encryption\`](#awscdkexperimentaledgefunctionpropspropertyenvironmentencryption) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | The AWS KMS key that's used to encrypt your function's environment variables. | -| [\`events\`](#awscdkexperimentaledgefunctionpropspropertyevents) | typing.List[[\`aws_cdk.aws_lambda.IEventSource\`](#aws_cdk.aws_lambda.IEventSource)] | Event sources for this function. | -| [\`filesystem\`](#awscdkexperimentaledgefunctionpropspropertyfilesystem) | [\`aws_cdk.aws_lambda.FileSystem\`](#aws_cdk.aws_lambda.FileSystem) | The filesystem configuration for the lambda function. | -| [\`function_name\`](#awscdkexperimentaledgefunctionpropspropertyfunctionname) | \`str\` | A name for the function. | -| [\`initial_policy\`](#awscdkexperimentaledgefunctionpropspropertyinitialpolicy) | typing.List[[\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement)] | Initial policy statements to add to the created Lambda Role. | -| [\`insights_version\`](#awscdkexperimentaledgefunctionpropspropertyinsightsversion) | [\`aws_cdk.aws_lambda.LambdaInsightsVersion\`](#aws_cdk.aws_lambda.LambdaInsightsVersion) | Specify the version of CloudWatch Lambda insights to use for monitoring. | -| [\`layers\`](#awscdkexperimentaledgefunctionpropspropertylayers) | typing.List[[\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion)] | A list of layers to add to the function's execution environment. | -| [\`log_retention\`](#awscdkexperimentaledgefunctionpropspropertylogretention) | [\`aws_cdk.aws_logs.RetentionDays\`](#aws_cdk.aws_logs.RetentionDays) | The number of days log events are kept in CloudWatch Logs. | -| [\`log_retention_retry_options\`](#awscdkexperimentaledgefunctionpropspropertylogretentionretryoptions) | [\`aws_cdk.aws_lambda.LogRetentionRetryOptions\`](#aws_cdk.aws_lambda.LogRetentionRetryOptions) | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | -| [\`log_retention_role\`](#awscdkexperimentaledgefunctionpropspropertylogretentionrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | -| [\`memory_size\`](#awscdkexperimentaledgefunctionpropspropertymemorysize) | \`typing.Union[int, float]\` | The amount of memory, in MB, that is allocated to your Lambda function. | -| [\`profiling\`](#awscdkexperimentaledgefunctionpropspropertyprofiling) | \`bool\` | Enable profiling. | -| [\`profiling_group\`](#awscdkexperimentaledgefunctionpropspropertyprofilinggroup) | [\`aws_cdk.aws_codeguruprofiler.IProfilingGroup\`](#aws_cdk.aws_codeguruprofiler.IProfilingGroup) | Profiling Group. | -| [\`reserved_concurrent_executions\`](#awscdkexperimentaledgefunctionpropspropertyreservedconcurrentexecutions) | \`typing.Union[int, float]\` | The maximum of concurrent executions you want to reserve for the function. | -| [\`role\`](#awscdkexperimentaledgefunctionpropspropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Lambda execution role. | -| [\`security_group\`](#awscdkexperimentaledgefunctionpropspropertysecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | -| [\`security_groups\`](#awscdkexperimentaledgefunctionpropspropertysecuritygroups) | typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] | The list of security groups to associate with the Lambda's network interfaces. | -| [\`timeout\`](#awscdkexperimentaledgefunctionpropspropertytimeout) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The function execution time (in seconds) after which Lambda terminates the function. | -| [\`tracing\`](#awscdkexperimentaledgefunctionpropspropertytracing) | [\`aws_cdk.aws_lambda.Tracing\`](#aws_cdk.aws_lambda.Tracing) | Enable AWS X-Ray Tracing for Lambda Function. | -| [\`vpc\`](#awscdkexperimentaledgefunctionpropspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | VPC network to place Lambda network interfaces. | -| [\`vpc_subnets\`](#awscdkexperimentaledgefunctionpropspropertyvpcsubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Where to place the network interfaces within the VPC. | -| [\`code\`](#awscdkexperimentaledgefunctionpropspropertycode)* | [\`aws_cdk.aws_lambda.Code\`](#aws_cdk.aws_lambda.Code) | The source code of your Lambda function. | -| [\`handler\`](#awscdkexperimentaledgefunctionpropspropertyhandler)* | \`str\` | The name of the method within your code that Lambda calls to execute your function. | -| [\`runtime\`](#awscdkexperimentaledgefunctionpropspropertyruntime)* | [\`aws_cdk.aws_lambda.Runtime\`](#aws_cdk.aws_lambda.Runtime) | The runtime environment for the Lambda function that you are uploading. | -| [\`stack_id\`](#awscdkexperimentaledgefunctionpropspropertystackid) | \`str\` | The stack ID of Lambda@Edge function. | - ---- - -##### \`max_event_age\`Optional +| max_event_age | aws_cdk.core.Duration | The maximum age of a request that Lambda sends to a function for processing. | +| on_failure | aws_cdk.aws_lambda.IDestination | The destination for failed invocations. | +| on_success | aws_cdk.aws_lambda.IDestination | The destination for successful invocations. | +| retry_attempts | typing.Union[int, float] | The maximum number of times to retry when the function returns an error. | +| allow_all_outbound | bool | Whether to allow the Lambda to send all network traffic. | +| allow_public_subnet | bool | Lambda Functions in a public subnet can NOT access the internet. | +| architectures | typing.List[aws_cdk.aws_lambda.Architecture] | The system architectures compatible with this lambda function. | +| code_signing_config | aws_cdk.aws_lambda.ICodeSigningConfig | Code signing config associated with this function. | +| current_version_options | aws_cdk.aws_lambda.VersionOptions | Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. | +| dead_letter_queue | aws_cdk.aws_sqs.IQueue | The SQS queue to use if DLQ is enabled. | +| dead_letter_queue_enabled | bool | Enabled DLQ. | +| description | str | A description of the function. | +| environment | typing.Mapping[str] | Key-value pairs that Lambda caches and makes available for your Lambda functions. | +| environment_encryption | aws_cdk.aws_kms.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | +| events | typing.List[aws_cdk.aws_lambda.IEventSource] | Event sources for this function. | +| filesystem | aws_cdk.aws_lambda.FileSystem | The filesystem configuration for the lambda function. | +| function_name | str | A name for the function. | +| initial_policy | typing.List[aws_cdk.aws_iam.PolicyStatement] | Initial policy statements to add to the created Lambda Role. | +| insights_version | aws_cdk.aws_lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | +| layers | typing.List[aws_cdk.aws_lambda.ILayerVersion] | A list of layers to add to the function's execution environment. | +| log_retention | aws_cdk.aws_logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | +| log_retention_retry_options | aws_cdk.aws_lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | +| log_retention_role | aws_cdk.aws_iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | +| memory_size | typing.Union[int, float] | The amount of memory, in MB, that is allocated to your Lambda function. | +| profiling | bool | Enable profiling. | +| profiling_group | aws_cdk.aws_codeguruprofiler.IProfilingGroup | Profiling Group. | +| reserved_concurrent_executions | typing.Union[int, float] | The maximum of concurrent executions you want to reserve for the function. | +| role | aws_cdk.aws_iam.IRole | Lambda execution role. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. | +| security_groups | typing.List[aws_cdk.aws_ec2.ISecurityGroup] | The list of security groups to associate with the Lambda's network interfaces. | +| timeout | aws_cdk.core.Duration | The function execution time (in seconds) after which Lambda terminates the function. | +| tracing | aws_cdk.aws_lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | +| vpc | aws_cdk.aws_ec2.IVpc | VPC network to place Lambda network interfaces. | +| vpc_subnets | aws_cdk.aws_ec2.SubnetSelection | Where to place the network interfaces within the VPC. | +| code | aws_cdk.aws_lambda.Code | The source code of your Lambda function. | +| handler | str | The name of the method within your code that Lambda calls to execute your function. | +| runtime | aws_cdk.aws_lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | +| stack_id | str | The stack ID of Lambda@Edge function. | + +--- + +##### \`max_event_age\`Optional \`\`\`python max_event_age: Duration \`\`\` -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. @@ -4367,39 +4366,39 @@ Minimum: 60 seconds Maximum: 6 hours --- -##### \`on_failure\`Optional +##### \`on_failure\`Optional \`\`\`python on_failure: IDestination \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- -##### \`on_success\`Optional +##### \`on_success\`Optional \`\`\`python on_success: IDestination \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.IDestination\`](#aws_cdk.aws_lambda.IDestination) +- *Type:* aws_cdk.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- -##### \`retry_attempts\`Optional +##### \`retry_attempts\`Optional \`\`\`python retry_attempts: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The maximum number of times to retry when the function returns an error. @@ -4408,13 +4407,13 @@ Minimum: 0 Maximum: 2 --- -##### \`allow_all_outbound\`Optional +##### \`allow_all_outbound\`Optional \`\`\`python allow_all_outbound: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether to allow the Lambda to send all network traffic. @@ -4423,82 +4422,82 @@ If set to false, you must individually add traffic rules to allow the Lambda to --- -##### \`allow_public_subnet\`Optional +##### \`allow_public_subnet\`Optional \`\`\`python allow_public_subnet: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. -> https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841 +> [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- -##### \`architectures\`Optional +##### \`architectures\`Optional \`\`\`python architectures: typing.List[Architecture] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_lambda.Architecture\`](#aws_cdk.aws_lambda.Architecture)] +- *Type:* typing.List[aws_cdk.aws_lambda.Architecture] - *Default:* [Architecture.X86_64] The system architectures compatible with this lambda function. --- -##### \`code_signing_config\`Optional +##### \`code_signing_config\`Optional \`\`\`python code_signing_config: ICodeSigningConfig \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ICodeSigningConfig\`](#aws_cdk.aws_lambda.ICodeSigningConfig) +- *Type:* aws_cdk.aws_lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- -##### \`current_version_options\`Optional +##### \`current_version_options\`Optional \`\`\`python current_version_options: VersionOptions \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.VersionOptions\`](#aws_cdk.aws_lambda.VersionOptions) +- *Type:* aws_cdk.aws_lambda.VersionOptions - *Default:* default options as described in \`VersionOptions\` Options for the \`lambda.Version\` resource automatically created by the \`fn.currentVersion\` method. --- -##### \`dead_letter_queue\`Optional +##### \`dead_letter_queue\`Optional \`\`\`python dead_letter_queue: IQueue \`\`\` -- *Type:* [\`aws_cdk.aws_sqs.IQueue\`](#aws_cdk.aws_sqs.IQueue) +- *Type:* aws_cdk.aws_sqs.IQueue - *Default:* SQS queue with 14 day retention period if \`deadLetterQueueEnabled\` is \`true\` The SQS queue to use if DLQ is enabled. --- -##### \`dead_letter_queue_enabled\`Optional +##### \`dead_letter_queue_enabled\`Optional \`\`\`python dead_letter_queue_enabled: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false unless \`deadLetterQueue\` is set, which implies DLQ is enabled. Enabled DLQ. @@ -4507,26 +4506,26 @@ If \`deadLetterQueue\` is undefined, an SQS queue with default options will be d --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description. A description of the function. --- -##### \`environment\`Optional +##### \`environment\`Optional \`\`\`python environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. @@ -4535,26 +4534,26 @@ Use environment variables to apply configuration changes, such as test and produ --- -##### \`environment_encryption\`Optional +##### \`environment_encryption\`Optional \`\`\`python environment_encryption: IKey \`\`\` -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- -##### \`events\`Optional +##### \`events\`Optional \`\`\`python events: typing.List[IEventSource] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_lambda.IEventSource\`](#aws_cdk.aws_lambda.IEventSource)] +- *Type:* typing.List[aws_cdk.aws_lambda.IEventSource] - *Default:* No event sources. Event sources for this function. @@ -4563,39 +4562,39 @@ You can also add event sources using \`addEventSource\`. --- -##### \`filesystem\`Optional +##### \`filesystem\`Optional \`\`\`python filesystem: FileSystem \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.FileSystem\`](#aws_cdk.aws_lambda.FileSystem) +- *Type:* aws_cdk.aws_lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- -##### \`function_name\`Optional +##### \`function_name\`Optional \`\`\`python function_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- -##### \`initial_policy\`Optional +##### \`initial_policy\`Optional \`\`\`python initial_policy: typing.List[PolicyStatement] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement)] +- *Type:* typing.List[aws_cdk.aws_iam.PolicyStatement] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. @@ -4604,28 +4603,28 @@ You can call \`addToRolePolicy\` to the created lambda to add statements post cr --- -##### \`insights_version\`Optional +##### \`insights_version\`Optional \`\`\`python insights_version: LambdaInsightsVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.LambdaInsightsVersion\`](#aws_cdk.aws_lambda.LambdaInsightsVersion) +- *Type:* aws_cdk.aws_lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. -> https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html +> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html) --- -##### \`layers\`Optional +##### \`layers\`Optional \`\`\`python layers: typing.List[ILayerVersion] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion)] +- *Type:* typing.List[aws_cdk.aws_lambda.ILayerVersion] - *Default:* No layers. A list of layers to add to the function's execution environment. @@ -4634,13 +4633,13 @@ You can configure your Lambda function to pull in additional code during initial --- -##### \`log_retention\`Optional +##### \`log_retention\`Optional \`\`\`python log_retention: RetentionDays \`\`\` -- *Type:* [\`aws_cdk.aws_logs.RetentionDays\`](#aws_cdk.aws_logs.RetentionDays) +- *Type:* aws_cdk.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. @@ -4649,13 +4648,13 @@ When updating this property, unsetting it doesn't remove the log retention polic --- -##### \`log_retention_retry_options\`Optional +##### \`log_retention_retry_options\`Optional \`\`\`python log_retention_retry_options: LogRetentionRetryOptions \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.LogRetentionRetryOptions\`](#aws_cdk.aws_lambda.LogRetentionRetryOptions) +- *Type:* aws_cdk.aws_lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. @@ -4664,26 +4663,26 @@ These options control the retry policy when interacting with CloudWatch APIs. --- -##### \`log_retention_role\`Optional +##### \`log_retention_role\`Optional \`\`\`python log_retention_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. --- -##### \`memory_size\`Optional +##### \`memory_size\`Optional \`\`\`python memory_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. @@ -4692,58 +4691,58 @@ Lambda uses this value to proportionally allocate the amount of CPU power. For m --- -##### \`profiling\`Optional +##### \`profiling\`Optional \`\`\`python profiling: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* No profiling. Enable profiling. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`profiling_group\`Optional +##### \`profiling_group\`Optional \`\`\`python profiling_group: IProfilingGroup \`\`\` -- *Type:* [\`aws_cdk.aws_codeguruprofiler.IProfilingGroup\`](#aws_cdk.aws_codeguruprofiler.IProfilingGroup) +- *Type:* aws_cdk.aws_codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if \`profiling\` is set. Profiling Group. -> https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html +> [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- -##### \`reserved_concurrent_executions\`Optional +##### \`reserved_concurrent_executions\`Optional \`\`\`python reserved_concurrent_executions: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. -> https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html +> [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling \`addToRolePolicy\`. Lambda execution role. @@ -4752,7 +4751,7 @@ This is the role that will be assumed by the function upon execution. It control --- -##### ~~\`security_group\`~~Optional +##### ~~\`security_group\`~~Optional - *Deprecated:* - This property is deprecated, use securityGroups instead @@ -4760,7 +4759,7 @@ This is the role that will be assumed by the function upon execution. It control security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function. What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. @@ -4769,13 +4768,13 @@ Only used if 'vpc' is supplied. Use securityGroups property instead. Function c --- -##### \`security_groups\`Optional +##### \`security_groups\`Optional \`\`\`python security_groups: typing.List[ISecurityGroup] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] +- *Type:* typing.List[aws_cdk.aws_ec2.ISecurityGroup] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. @@ -4784,13 +4783,13 @@ Only used if 'vpc' is supplied. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`python timeout: Duration \`\`\` -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. @@ -4799,26 +4798,26 @@ Because the execution time affects cost, set this value based on the function's --- -##### \`tracing\`Optional +##### \`tracing\`Optional \`\`\`python tracing: Tracing \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.Tracing\`](#aws_cdk.aws_lambda.Tracing) +- *Type:* aws_cdk.aws_lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. @@ -4827,13 +4826,13 @@ Specify this if the Lambda function needs to access resources in a VPC. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. @@ -4842,13 +4841,13 @@ Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT --- -##### \`code\`Required +##### \`code\`Required \`\`\`python code: Code \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.Code\`](#aws_cdk.aws_lambda.Code) +- *Type:* aws_cdk.aws_lambda.Code The source code of your Lambda function. @@ -4856,13 +4855,13 @@ You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket o --- -##### \`handler\`Required +##### \`handler\`Required \`\`\`python handler: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the method within your code that Lambda calls to execute your function. @@ -4870,13 +4869,13 @@ The format includes the file name. It can also include namespaces and other qual --- -##### \`runtime\`Required +##### \`runtime\`Required \`\`\`python runtime: Runtime \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.Runtime\`](#aws_cdk.aws_lambda.Runtime) +- *Type:* aws_cdk.aws_lambda.Runtime The runtime environment for the Lambda function that you are uploading. @@ -4884,13 +4883,13 @@ For valid values, see the Runtime property in the AWS Lambda Developer Guide. U --- -##### \`stack_id\`Optional +##### \`stack_id\`Optional \`\`\`python stack_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* \`edge-lambda-stack-\${region}\` The stack ID of Lambda@Edge function. diff --git a/test/docgen/transpile/transpile.test.ts b/test/docgen/transpile/transpile.test.ts index fa5896d7..1ddd6a18 100644 --- a/test/docgen/transpile/transpile.test.ts +++ b/test/docgen/transpile/transpile.test.ts @@ -36,19 +36,19 @@ describe('submodules without an explicit name', () => { test('java', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-cloudfront', Assemblies.AWSCDK_1_126_0); - const markdown = await docs.render({ language: Language.JAVA, submodule: 'experimental' }); + const markdown = await docs.toMarkdown({ language: Language.JAVA, submodule: 'experimental' }); expect(markdown.render()).toMatchSnapshot(); }); test('python', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-cloudfront', Assemblies.AWSCDK_1_126_0); - const markdown = await docs.render({ language: Language.PYTHON, submodule: 'experimental' }); + const markdown = await docs.toMarkdown({ language: Language.PYTHON, submodule: 'experimental' }); expect(markdown.render()).toMatchSnapshot(); }); test('csharp', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-cloudfront', Assemblies.AWSCDK_1_126_0); - const markdown = await docs.render({ language: Language.CSHARP, submodule: 'experimental' }); + const markdown = await docs.toMarkdown({ language: Language.CSHARP, submodule: 'experimental' }); expect(markdown.render()).toMatchSnapshot(); }); }); diff --git a/test/docgen/view/__snapshots__/class.test.ts.snap b/test/docgen/view/__snapshots__/class.test.ts.snap index 3d2fc6a0..c650758a 100644 --- a/test/docgen/view/__snapshots__/class.test.ts.snap +++ b/test/docgen/view/__snapshots__/class.test.ts.snap @@ -1,22 +1,77 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" AuthorizationToken +Object { + "constants": Array [], + "displayName": "AuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html", + ], + "summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.", + }, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken", + "id": "@aws-cdk/aws-ecr.AuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "GrantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken.GrantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken.GrantRead.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "using Amazon.CDK.AWS.ECR; + +AuthorizationToken.GrantRead(IGrantable Grantee);", + }, + ], +} +`; + +exports[`csharp snapshot 2`] = ` +" AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -# Static Functions +# Static Functions | **Name** | **Description** | | --- | --- | -| [\`GrantRead\`](#amazoncdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| GrantRead | Grant access to retrieve an authorization token. | --- -## \`GrantRead\` +## \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -24,9 +79,9 @@ using Amazon.CDK.AWS.ECR; AuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -### \`Grantee\`Required +### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- @@ -35,22 +90,77 @@ AuthorizationToken.GrantRead(IGrantable Grantee); `; exports[`java snapshot 1`] = ` -" AuthorizationToken +Object { + "constants": Array [], + "displayName": "AuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html", + ], + "summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.", + }, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken", + "id": "@aws-cdk/aws-ecr.AuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "grantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken.grantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import software.amazon.awscdk.services.ecr.AuthorizationToken; + +AuthorizationToken.grantRead(IGrantable grantee)", + }, + ], +} +`; + +exports[`java snapshot 2`] = ` +" AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -# Static Functions +# Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#softwareamazonawscdkservicesecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -## \`grantRead\` +## \`grantRead\` \`\`\`java import software.amazon.awscdk.services.ecr.AuthorizationToken; @@ -58,9 +168,9 @@ import software.amazon.awscdk.services.ecr.AuthorizationToken; AuthorizationToken.grantRead(IGrantable grantee) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- @@ -69,22 +179,79 @@ AuthorizationToken.grantRead(IGrantable grantee) `; exports[`python snapshot 1`] = ` -" AuthorizationToken +Object { + "constants": Array [], + "displayName": "AuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html", + ], + "summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.", + }, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken", + "id": "@aws-cdk/aws-ecr.AuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "grant_read", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.AuthorizationToken.grant_read( + grantee: IGrantable +)", + }, + ], +} +`; + +exports[`python snapshot 2`] = ` +" AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -# Static Functions +# Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grant_read | Grant access to retrieve an authorization token. | --- -## \`grant_read\` +## \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -94,9 +261,9 @@ aws_cdk.aws_ecr.AuthorizationToken.grant_read( ) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- @@ -105,22 +272,77 @@ aws_cdk.aws_ecr.AuthorizationToken.grant_read( `; exports[`typescript snapshot 1`] = ` -" AuthorizationToken +Object { + "constants": Array [], + "displayName": "AuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html", + ], + "summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.", + }, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken", + "id": "@aws-cdk/aws-ecr.AuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "grantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import { AuthorizationToken } from '@aws-cdk/aws-ecr' + +AuthorizationToken.grantRead(grantee: IGrantable)", + }, + ], +} +`; + +exports[`typescript snapshot 2`] = ` +" AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -# Static Functions +# Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -## \`grantRead\` +## \`grantRead\` \`\`\`typescript import { AuthorizationToken } from '@aws-cdk/aws-ecr' @@ -128,9 +350,9 @@ import { AuthorizationToken } from '@aws-cdk/aws-ecr' AuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- diff --git a/test/docgen/view/__snapshots__/documentation.test.ts.snap b/test/docgen/view/__snapshots__/documentation.test.ts.snap index 7e910cf0..4b44adf6 100644 --- a/test/docgen/view/__snapshots__/documentation.test.ts.snap +++ b/test/docgen/view/__snapshots__/documentation.test.ts.snap @@ -104,17 +104,17 @@ repository.AddLifecycleRule(new Struct { MaxImageAge = cdk.Duration.Days(30) }); \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -124,88 +124,88 @@ new CfnPublicRepository(Construct Scope, string Id, CfnPublicRepositoryProps Pro | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnpublicrepositoryparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnpublicrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnPublicRepositoryProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsecrcfnpublicrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsecrcfnpublicrepositorypropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`RepositoryCatalogData\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| RepositoryCatalogData | object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| RepositoryPolicyText | object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| RepositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -213,13 +213,13 @@ public TagManager Tags { get; } --- -##### \`RepositoryCatalogData\`Required +##### \`RepositoryCatalogData\`Required \`\`\`csharp public object RepositoryCatalogData { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -227,13 +227,13 @@ public object RepositoryCatalogData { get; } --- -##### \`RepositoryPolicyText\`Required +##### \`RepositoryPolicyText\`Required \`\`\`csharp public object RepositoryPolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -241,13 +241,13 @@ public object RepositoryPolicyText { get; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -255,31 +255,35 @@ public string RepositoryName { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -289,85 +293,85 @@ new CfnRegistryPolicy(Construct Scope, string Id, CfnRegistryPolicyProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnregistrypolicyparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnregistrypolicyparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnregistrypolicyparameterprops)* | [\`Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps\`](#Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnRegistryPolicyProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps\`](#Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps) +- *Type:* CfnRegistryPolicyProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrRegistryId\`](#amazoncdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`string\` | *No description.* | -| [\`PolicyText\`](#amazoncdkawsecrcfnregistrypolicypropertypolicytext)* | \`object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| AttrRegistryId | string | *No description.* | +| PolicyText | object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`AttrRegistryId\`Required +##### \`AttrRegistryId\`Required \`\`\`csharp public string AttrRegistryId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`PolicyText\`Required +##### \`PolicyText\`Required \`\`\`csharp public object PolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -375,31 +379,35 @@ public object PolicyText { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -409,79 +417,79 @@ new CfnReplicationConfiguration(Construct Scope, string Id, CfnReplicationConfig | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnreplicationconfigurationparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnreplicationconfigurationparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnreplicationconfigurationparameterprops)* | [\`Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps\`](#Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnReplicationConfigurationProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps\`](#Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps) +- *Type:* CfnReplicationConfigurationProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrRegistryId\`](#amazoncdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`string\` | *No description.* | -| [\`ReplicationConfiguration\`](#amazoncdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| AttrRegistryId | string | *No description.* | +| ReplicationConfiguration | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`AttrRegistryId\`Required +##### \`AttrRegistryId\`Required \`\`\`csharp public string AttrRegistryId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`ReplicationConfiguration\`Required +##### \`ReplicationConfiguration\`Required \`\`\`csharp public object ReplicationConfiguration { get; } @@ -495,31 +503,35 @@ public object ReplicationConfiguration { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -529,102 +541,102 @@ new CfnRepository(Construct Scope, string Id, CfnRepositoryProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnrepositoryparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.CfnRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnRepositoryProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnRepositoryProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnRepositoryProps) +- *Type:* CfnRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsecrcfnrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrRepositoryUri\`](#amazoncdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsecrcfnrepositorypropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`EncryptionConfiguration\`](#amazoncdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`ImageScanningConfiguration\`](#amazoncdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`ImageTagMutability\`](#amazoncdkawsecrcfnrepositorypropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`LifecyclePolicy\`](#amazoncdkawsecrcfnrepositorypropertylifecyclepolicy) | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | +| AttrArn | string | *No description.* | +| AttrRepositoryUri | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::ECR::Repository.Tags\`. | +| EncryptionConfiguration | object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| ImageScanningConfiguration | object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| RepositoryPolicyText | object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| ImageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| LifecyclePolicy | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| RepositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrRepositoryUri\`Required +##### \`AttrRepositoryUri\`Required \`\`\`csharp public string AttrRepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::ECR::Repository.Tags\`. @@ -632,13 +644,13 @@ public TagManager Tags { get; } --- -##### \`EncryptionConfiguration\`Required +##### \`EncryptionConfiguration\`Required \`\`\`csharp public object EncryptionConfiguration { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -646,13 +658,13 @@ public object EncryptionConfiguration { get; } --- -##### \`ImageScanningConfiguration\`Required +##### \`ImageScanningConfiguration\`Required \`\`\`csharp public object ImageScanningConfiguration { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -660,13 +672,13 @@ public object ImageScanningConfiguration { get; } --- -##### \`RepositoryPolicyText\`Required +##### \`RepositoryPolicyText\`Required \`\`\`csharp public object RepositoryPolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -674,13 +686,13 @@ public object RepositoryPolicyText { get; } --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public string ImageTagMutability { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -688,7 +700,7 @@ public string ImageTagMutability { get; } --- -##### \`LifecyclePolicy\`Optional +##### \`LifecyclePolicy\`Optional \`\`\`csharp public object LifecyclePolicy { get; } @@ -702,13 +714,13 @@ public object LifecyclePolicy { get; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -716,27 +728,31 @@ public string RepositoryName { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -746,75 +762,75 @@ new Repository(Construct Scope, string Id, RepositoryProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrrepositoryparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsecrrepositoryparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsecrrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.RepositoryProps\`](#Amazon.CDK.AWS.ECR.RepositoryProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | RepositoryProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.RepositoryProps\`](#Amazon.CDK.AWS.ECR.RepositoryProps) +- *Type:* RepositoryProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddLifecycleRule\`](#amazoncdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| AddLifecycleRule | Add a life cycle rule to the repository. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`AddLifecycleRule\` +##### \`AddLifecycleRule\` \`\`\`csharp private AddLifecycleRule(LifecycleRule Rule) \`\`\` -###### \`Rule\`Required +###### \`Rule\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule) +- *Type:* LifecycleRule --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`ArnForLocalRepository\`](#amazoncdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`FromRepositoryArn\`](#amazoncdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`FromRepositoryAttributes\`](#amazoncdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`FromRepositoryName\`](#amazoncdkawsecrrepositoryfromrepositoryname) | *No description.* | +| ArnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| FromRepositoryArn | *No description.* | +| FromRepositoryAttributes | Import a repository. | +| FromRepositoryName | *No description.* | --- -##### \`ArnForLocalRepository\` +##### \`ArnForLocalRepository\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -822,25 +838,25 @@ using Amazon.CDK.AWS.ECR; Repository.ArnForLocalRepository(string RepositoryName, IConstruct Scope, string Account = null); \`\`\` -###### \`RepositoryName\`Required +###### \`RepositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.IConstruct\`](#Constructs.IConstruct) +- *Type:* Constructs.IConstruct --- -###### \`Account\`Optional +###### \`Account\`Optional -- *Type:* \`string\` +- *Type:* string --- -##### \`FromRepositoryArn\` +##### \`FromRepositoryArn\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -848,25 +864,25 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryArn(Construct Scope, string Id, string RepositoryArn); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`RepositoryArn\`Required +###### \`RepositoryArn\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`FromRepositoryAttributes\` +##### \`FromRepositoryAttributes\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -874,25 +890,25 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryAttributes(Construct Scope, string Id, RepositoryAttributes Attrs); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Attrs\`Required +###### \`Attrs\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.RepositoryAttributes\`](#Amazon.CDK.AWS.ECR.RepositoryAttributes) +- *Type:* RepositoryAttributes --- -##### \`FromRepositoryName\` +##### \`FromRepositoryName\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -900,67 +916,67 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryName(Construct Scope, string Id, string RepositoryName); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`RepositoryName\`Required +###### \`RepositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`Amazon.CDK.AWS.ECR.IRepository\`](#Amazon.CDK.AWS.ECR.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -970,255 +986,255 @@ new RepositoryBase(Construct Scope, string Id, ResourceProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrrepositorybaseparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsecrrepositorybaseparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsecrrepositorybaseparameterprops) | [\`Amazon.CDK.ResourceProps\`](#Amazon.CDK.ResourceProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.ResourceProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.ResourceProps\`](#Amazon.CDK.ResourceProps) +- *Type:* Amazon.CDK.ResourceProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`Grant\`](#amazoncdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`GrantPull\`](#amazoncdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`GrantPullPush\`](#amazoncdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`OnCloudTrailEvent\`](#amazoncdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`OnCloudTrailImagePushed\`](#amazoncdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`OnEvent\`](#amazoncdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`OnImageScanCompleted\`](#amazoncdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`RepositoryUriForDigest\`](#amazoncdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`RepositoryUriForTag\`](#amazoncdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | +| Grant | Grant the given principal identity permissions to perform the actions on this repository. | +| GrantPull | Grant the given identity permissions to use the images in this repository. | +| GrantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| OnCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| OnCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| OnEvent | Defines a CloudWatch event rule which triggers for repository events. | +| OnImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| RepositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| RepositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -##### \`Grant\` +##### \`Grant\` \`\`\`csharp private Grant(IGrantable Grantee, string Actions) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -###### \`Actions\`Required +###### \`Actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`GrantPull\` +##### \`GrantPull\` \`\`\`csharp private GrantPull(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`GrantPullPush\` +##### \`GrantPullPush\` \`\`\`csharp private GrantPullPush(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`OnCloudTrailEvent\` +##### \`OnCloudTrailEvent\` \`\`\`csharp private OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- -##### \`OnCloudTrailImagePushed\` +##### \`OnCloudTrailImagePushed\` \`\`\`csharp private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions\`](#Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`OnEvent\` +##### \`OnEvent\` \`\`\`csharp private OnEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- -##### \`OnImageScanCompleted\` +##### \`OnImageScanCompleted\` \`\`\`csharp private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions\`](#Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`RepositoryUriForDigest\` +##### \`RepositoryUriForDigest\` \`\`\`csharp private RepositoryUriForDigest(string Digest = null) \`\`\` -###### \`Digest\`Optional +###### \`Digest\`Optional -- *Type:* \`string\` +- *Type:* string Optional image digest. --- -##### \`RepositoryUriForTag\` +##### \`RepositoryUriForTag\` \`\`\`csharp private RepositoryUriForTag(string Tag = null) \`\`\` -###### \`Tag\`Optional +###### \`Tag\`Optional -- *Type:* \`string\` +- *Type:* string Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositorybasepropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorybasepropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`RepositoryUri\`](#amazoncdkawsecrrepositorybasepropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | +| RepositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`RepositoryUri\`Required +##### \`RepositoryUri\`Required \`\`\`csharp public string RepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -1227,15 +1243,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1248,24 +1264,24 @@ new CfnPublicRepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryCatalogData\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`Tags\`](#amazoncdkawsecrcfnpublicrepositorypropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| RepositoryCatalogData | object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| RepositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| RepositoryPolicyText | object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`RepositoryCatalogData\`Optional +##### \`RepositoryCatalogData\`Optional \`\`\`csharp public object RepositoryCatalogData { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -1273,13 +1289,13 @@ public object RepositoryCatalogData { get; set; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -1287,13 +1303,13 @@ public string RepositoryName { get; set; } --- -##### \`RepositoryPolicyText\`Optional +##### \`RepositoryPolicyText\`Optional \`\`\`csharp public object RepositoryPolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -1301,13 +1317,13 @@ public object RepositoryPolicyText { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. @@ -1315,13 +1331,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1331,21 +1347,21 @@ new CfnRegistryPolicyProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PolicyText\`](#amazoncdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| PolicyText | object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`PolicyText\`Required +##### \`PolicyText\`Required \`\`\`csharp public object PolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -1353,13 +1369,13 @@ public object PolicyText { get; set; } --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1369,15 +1385,15 @@ new CfnReplicationConfigurationProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ReplicationConfiguration\`](#amazoncdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| ReplicationConfiguration | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`ReplicationConfiguration\`Required +##### \`ReplicationConfiguration\`Required \`\`\`csharp public object ReplicationConfiguration { get; set; } @@ -1391,13 +1407,13 @@ public object ReplicationConfiguration { get; set; } --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1413,27 +1429,27 @@ new CfnRepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`EncryptionConfiguration\`](#amazoncdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`ImageScanningConfiguration\`](#amazoncdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`ImageTagMutability\`](#amazoncdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`LifecyclePolicy\`](#amazoncdkawsecrcfnrepositorypropspropertylifecyclepolicy) | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`Tags\`](#amazoncdkawsecrcfnrepositorypropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::ECR::Repository.Tags\`. | +| EncryptionConfiguration | object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| ImageScanningConfiguration | object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| ImageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| LifecyclePolicy | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| RepositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | +| RepositoryPolicyText | object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`EncryptionConfiguration\`Optional +##### \`EncryptionConfiguration\`Optional \`\`\`csharp public object EncryptionConfiguration { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -1441,13 +1457,13 @@ public object EncryptionConfiguration { get; set; } --- -##### \`ImageScanningConfiguration\`Optional +##### \`ImageScanningConfiguration\`Optional \`\`\`csharp public object ImageScanningConfiguration { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -1455,13 +1471,13 @@ public object ImageScanningConfiguration { get; set; } --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public string ImageTagMutability { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -1469,7 +1485,7 @@ public string ImageTagMutability { get; set; } --- -##### \`LifecyclePolicy\`Optional +##### \`LifecyclePolicy\`Optional \`\`\`csharp public object LifecyclePolicy { get; set; } @@ -1483,13 +1499,13 @@ public object LifecyclePolicy { get; set; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -1497,13 +1513,13 @@ public string RepositoryName { get; set; } --- -##### \`RepositoryPolicyText\`Optional +##### \`RepositoryPolicyText\`Optional \`\`\`csharp public object RepositoryPolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -1511,13 +1527,13 @@ public object RepositoryPolicyText { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::ECR::Repository.Tags\`. @@ -1525,11 +1541,11 @@ public CfnTag[] Tags { get; set; } --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1540,22 +1556,22 @@ new LifecyclePolicyProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`LifecyclePolicyText\`](#amazoncdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`RegistryId\`](#amazoncdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| LifecyclePolicyText | string | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| RegistryId | string | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`LifecyclePolicyText\`Optional +##### \`LifecyclePolicyText\`Optional \`\`\`csharp public string LifecyclePolicyText { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -1563,13 +1579,13 @@ public string LifecyclePolicyText { get; set; } --- -##### \`RegistryId\`Optional +##### \`RegistryId\`Optional \`\`\`csharp public string RegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -1577,11 +1593,11 @@ public string RegistryId { get; set; } --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1596,39 +1612,39 @@ new LifecycleRule { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecrlifecyclerulepropertydescription) | \`string\` | Describes the purpose of the rule. | -| [\`MaxImageAge\`](#amazoncdkawsecrlifecyclerulepropertymaximageage) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`MaxImageCount\`](#amazoncdkawsecrlifecyclerulepropertymaximagecount) | \`double\` | The maximum number of images to retain. | -| [\`RulePriority\`](#amazoncdkawsecrlifecyclerulepropertyrulepriority) | \`double\` | Controls the order in which rules are evaluated (low to high). | -| [\`TagPrefixList\`](#amazoncdkawsecrlifecyclerulepropertytagprefixlist) | \`string\`[] | Select images that have ALL the given prefixes in their tag. | -| [\`TagStatus\`](#amazoncdkawsecrlifecyclerulepropertytagstatus) | [\`Amazon.CDK.AWS.ECR.TagStatus\`](#Amazon.CDK.AWS.ECR.TagStatus) | Select images based on tags. | +| Description | string | Describes the purpose of the rule. | +| MaxImageAge | Amazon.CDK.Duration | The maximum age of images to retain. The value must represent a number of days. | +| MaxImageCount | double | The maximum number of images to retain. | +| RulePriority | double | Controls the order in which rules are evaluated (low to high). | +| TagPrefixList | string[] | Select images that have ALL the given prefixes in their tag. | +| TagStatus | TagStatus | Select images based on tags. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description Describes the purpose of the rule. --- -##### \`MaxImageAge\`Optional +##### \`MaxImageAge\`Optional \`\`\`csharp public Duration MaxImageAge { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration The maximum age of images to retain. The value must represent a number of days. @@ -1636,13 +1652,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`MaxImageCount\`Optional +##### \`MaxImageCount\`Optional \`\`\`csharp public double MaxImageCount { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double The maximum number of images to retain. @@ -1650,13 +1666,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`RulePriority\`Optional +##### \`RulePriority\`Optional \`\`\`csharp public double RulePriority { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -1665,13 +1681,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`TagPrefixList\`Optional +##### \`TagPrefixList\`Optional \`\`\`csharp public string[] TagPrefixList { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] Select images that have ALL the given prefixes in their tag. @@ -1679,13 +1695,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`TagStatus\`Optional +##### \`TagStatus\`Optional \`\`\`csharp public TagStatus TagStatus { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.TagStatus\`](#Amazon.CDK.AWS.ECR.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -1694,11 +1710,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1712,92 +1728,92 @@ new OnCloudTrailImagePushedOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`EventPattern\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`RuleName\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`Target\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) | The target to register for the event. | -| [\`ImageTag\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`string\` | Only watch changes to this image tag. | +| Description | string | A description of the rule's purpose. | +| EventPattern | Amazon.CDK.AWS.Events.EventPattern | Additional restrictions for the event to route to the specified target. | +| RuleName | string | A name for the rule. | +| Target | Amazon.CDK.AWS.Events.IRuleTarget | The target to register for the event. | +| ImageTag | string | Only watch changes to this image tag. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`EventPattern\`Optional +##### \`EventPattern\`Optional \`\`\`csharp public EventPattern EventPattern { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) +- *Type:* Amazon.CDK.AWS.Events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`RuleName\`Optional +##### \`RuleName\`Optional \`\`\`csharp public string RuleName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`Target\`Optional +##### \`Target\`Optional \`\`\`csharp public IRuleTarget Target { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) +- *Type:* Amazon.CDK.AWS.Events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`ImageTag\`Optional +##### \`ImageTag\`Optional \`\`\`csharp public string ImageTag { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1811,81 +1827,81 @@ new OnImageScanCompletedOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecronimagescancompletedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`EventPattern\`](#amazoncdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`RuleName\`](#amazoncdkawsecronimagescancompletedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`Target\`](#amazoncdkawsecronimagescancompletedoptionspropertytarget) | [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) | The target to register for the event. | -| [\`ImageTags\`](#amazoncdkawsecronimagescancompletedoptionspropertyimagetags) | \`string\`[] | Only watch changes to the image tags spedified. | +| Description | string | A description of the rule's purpose. | +| EventPattern | Amazon.CDK.AWS.Events.EventPattern | Additional restrictions for the event to route to the specified target. | +| RuleName | string | A name for the rule. | +| Target | Amazon.CDK.AWS.Events.IRuleTarget | The target to register for the event. | +| ImageTags | string[] | Only watch changes to the image tags spedified. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`EventPattern\`Optional +##### \`EventPattern\`Optional \`\`\`csharp public EventPattern EventPattern { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) +- *Type:* Amazon.CDK.AWS.Events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`RuleName\`Optional +##### \`RuleName\`Optional \`\`\`csharp public string RuleName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`Target\`Optional +##### \`Target\`Optional \`\`\`csharp public IRuleTarget Target { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) +- *Type:* Amazon.CDK.AWS.Events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`ImageTags\`Optional +##### \`ImageTags\`Optional \`\`\`csharp public string[] ImageTags { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -1894,11 +1910,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1908,15 +1924,15 @@ new ReplicationConfigurationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Rules\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | object | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| Rules | object | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`Rules\`Required +##### \`Rules\`Required \`\`\`csharp public object Rules { get; set; } @@ -1930,11 +1946,11 @@ public object Rules { get; set; } --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1945,22 +1961,22 @@ new ReplicationDestinationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Region\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`RegistryId\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| Region | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| RegistryId | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`Region\`Required +##### \`Region\`Required \`\`\`csharp public string Region { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -1968,13 +1984,13 @@ public string Region { get; set; } --- -##### \`RegistryId\`Required +##### \`RegistryId\`Required \`\`\`csharp public string RegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -1982,11 +1998,11 @@ public string RegistryId { get; set; } --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -1996,15 +2012,15 @@ new ReplicationRuleProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Destinations\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | object | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| Destinations | object | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`Destinations\`Required +##### \`Destinations\`Required \`\`\`csharp public object Destinations { get; set; } @@ -2018,9 +2034,9 @@ public object Destinations { get; set; } --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2031,38 +2047,38 @@ new RepositoryAttributes { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositoryattributespropertyrepositoryarn)* | \`string\` | *No description.* | -| [\`RepositoryName\`](#amazoncdkawsecrrepositoryattributespropertyrepositoryname)* | \`string\` | *No description.* | +| RepositoryArn | string | *No description.* | +| RepositoryName | string | *No description.* | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2077,39 +2093,39 @@ new RepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ImageScanOnPush\`](#amazoncdkawsecrrepositorypropspropertyimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`ImageTagMutability\`](#amazoncdkawsecrrepositorypropspropertyimagetagmutability) | [\`Amazon.CDK.AWS.ECR.TagMutability\`](#Amazon.CDK.AWS.ECR.TagMutability) | The tag mutability setting for the repository. | -| [\`LifecycleRegistryId\`](#amazoncdkawsecrrepositorypropspropertylifecycleregistryid) | \`string\` | The AWS account ID associated with the registry that contains the repository. | -| [\`LifecycleRules\`](#amazoncdkawsecrrepositorypropspropertylifecyclerules) | [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule)[] | Life cycle rules to apply to this registry. | -| [\`RemovalPolicy\`](#amazoncdkawsecrrepositorypropspropertyremovalpolicy) | [\`Amazon.CDK.RemovalPolicy\`](#Amazon.CDK.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorypropspropertyrepositoryname) | \`string\` | Name for this repository. | +| ImageScanOnPush | bool | Enable the scan on push when creating the repository. | +| ImageTagMutability | TagMutability | The tag mutability setting for the repository. | +| LifecycleRegistryId | string | The AWS account ID associated with the registry that contains the repository. | +| LifecycleRules | LifecycleRule[] | Life cycle rules to apply to this registry. | +| RemovalPolicy | Amazon.CDK.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| RepositoryName | string | Name for this repository. | --- -##### \`ImageScanOnPush\`Optional +##### \`ImageScanOnPush\`Optional \`\`\`csharp public bool ImageScanOnPush { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public TagMutability ImageTagMutability { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.TagMutability\`](#Amazon.CDK.AWS.ECR.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -2118,78 +2134,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`LifecycleRegistryId\`Optional +##### \`LifecycleRegistryId\`Optional \`\`\`csharp public string LifecycleRegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`LifecycleRules\`Optional +##### \`LifecycleRules\`Optional \`\`\`csharp public LifecycleRule[] LifecycleRules { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule)[] +- *Type:* LifecycleRule[] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`RemovalPolicy\`Optional +##### \`RemovalPolicy\`Optional \`\`\`csharp public RemovalPolicy RemovalPolicy { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.RemovalPolicy\`](#Amazon.CDK.RemovalPolicy) +- *Type:* Amazon.CDK.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`GrantRead\`](#amazoncdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| GrantRead | Grant access to retrieve an authorization token. | --- -##### \`GrantRead\` +##### \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2197,30 +2213,30 @@ using Amazon.CDK.AWS.ECR; AuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`GrantRead\`](#amazoncdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| GrantRead | Grant access to retrieve an authorization token. | --- -##### \`GrantRead\` +##### \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2228,239 +2244,239 @@ using Amazon.CDK.AWS.ECR; PublicGalleryAuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource) +- *Extends:* Amazon.CDK.IResource -- *Implemented By:* [\`Amazon.CDK.AWS.ECR.Repository\`](#Amazon.CDK.AWS.ECR.Repository), [\`Amazon.CDK.AWS.ECR.RepositoryBase\`](#Amazon.CDK.AWS.ECR.RepositoryBase), [\`Amazon.CDK.AWS.ECR.IRepository\`](#Amazon.CDK.AWS.ECR.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`Grant\`](#amazoncdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`GrantPull\`](#amazoncdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`GrantPullPush\`](#amazoncdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`OnCloudTrailEvent\`](#amazoncdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`OnCloudTrailImagePushed\`](#amazoncdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`OnEvent\`](#amazoncdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`OnImageScanCompleted\`](#amazoncdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`RepositoryUriForDigest\`](#amazoncdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`RepositoryUriForTag\`](#amazoncdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | +| Grant | Grant the given principal identity permissions to perform the actions on this repository. | +| GrantPull | Grant the given identity permissions to pull images in this repository. | +| GrantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| OnCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| OnCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| OnEvent | Defines a CloudWatch event rule which triggers for repository events. | +| OnImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| RepositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| RepositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -##### \`Grant\` +##### \`Grant\` \`\`\`csharp private Grant(IGrantable Grantee, string Actions) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -###### \`Actions\`Required +###### \`Actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`GrantPull\` +##### \`GrantPull\` \`\`\`csharp private GrantPull(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`GrantPullPush\` +##### \`GrantPullPush\` \`\`\`csharp private GrantPullPush(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`OnCloudTrailEvent\` +##### \`OnCloudTrailEvent\` \`\`\`csharp private OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- -##### \`OnCloudTrailImagePushed\` +##### \`OnCloudTrailImagePushed\` \`\`\`csharp private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions\`](#Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`OnEvent\` +##### \`OnEvent\` \`\`\`csharp private OnEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- -##### \`OnImageScanCompleted\` +##### \`OnImageScanCompleted\` \`\`\`csharp private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions\`](#Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`RepositoryUriForDigest\` +##### \`RepositoryUriForDigest\` \`\`\`csharp private RepositoryUriForDigest(string Digest = null) \`\`\` -###### \`Digest\`Optional +###### \`Digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`RepositoryUriForTag\` +##### \`RepositoryUriForTag\` \`\`\`csharp private RepositoryUriForTag(string Tag = null) \`\`\` -###### \`Tag\`Optional +###### \`Tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawsecrirepositorypropertynode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct tree node for this construct. | -| [\`Env\`](#amazoncdkawsecrirepositorypropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawsecrirepositorypropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`RepositoryArn\`](#amazoncdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`RepositoryUri\`](#amazoncdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| Node | Amazon.CDK.ConstructNode | The construct tree node for this construct. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | +| RepositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public ConstructNode Node { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -2468,49 +2484,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`RepositoryUri\`Required +##### \`RepositoryUri\`Required \`\`\`csharp public string RepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -2518,60 +2534,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#amazoncdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#amazoncdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#amazoncdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#amazoncdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#amazoncdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -2684,17 +2700,17 @@ repository.AddLifecycleRule(new Struct { MaxImageAge = cdk.Duration.Days(30) }); \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2704,88 +2720,88 @@ new CfnPublicRepository(Construct Scope, string Id, CfnPublicRepositoryProps Pro | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnpublicrepositoryparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnpublicrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnPublicRepositoryProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsecrcfnpublicrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsecrcfnpublicrepositorypropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`RepositoryCatalogData\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| RepositoryCatalogData | object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| RepositoryPolicyText | object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| RepositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -2793,13 +2809,13 @@ public TagManager Tags { get; } --- -##### \`RepositoryCatalogData\`Required +##### \`RepositoryCatalogData\`Required \`\`\`csharp public object RepositoryCatalogData { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -2807,13 +2823,13 @@ public object RepositoryCatalogData { get; } --- -##### \`RepositoryPolicyText\`Required +##### \`RepositoryPolicyText\`Required \`\`\`csharp public object RepositoryPolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -2821,13 +2837,13 @@ public object RepositoryPolicyText { get; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -2835,31 +2851,35 @@ public string RepositoryName { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2869,85 +2889,85 @@ new CfnRegistryPolicy(Construct Scope, string Id, CfnRegistryPolicyProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnregistrypolicyparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnregistrypolicyparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnregistrypolicyparameterprops)* | [\`Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps\`](#Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnRegistryPolicyProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps\`](#Amazon.CDK.AWS.ECR.CfnRegistryPolicyProps) +- *Type:* CfnRegistryPolicyProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrRegistryId\`](#amazoncdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`string\` | *No description.* | -| [\`PolicyText\`](#amazoncdkawsecrcfnregistrypolicypropertypolicytext)* | \`object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| AttrRegistryId | string | *No description.* | +| PolicyText | object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`AttrRegistryId\`Required +##### \`AttrRegistryId\`Required \`\`\`csharp public string AttrRegistryId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`PolicyText\`Required +##### \`PolicyText\`Required \`\`\`csharp public object PolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -2955,31 +2975,35 @@ public object PolicyText { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -2989,79 +3013,79 @@ new CfnReplicationConfiguration(Construct Scope, string Id, CfnReplicationConfig | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnreplicationconfigurationparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnreplicationconfigurationparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnreplicationconfigurationparameterprops)* | [\`Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps\`](#Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnReplicationConfigurationProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps\`](#Amazon.CDK.AWS.ECR.CfnReplicationConfigurationProps) +- *Type:* CfnReplicationConfigurationProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrRegistryId\`](#amazoncdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`string\` | *No description.* | -| [\`ReplicationConfiguration\`](#amazoncdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| AttrRegistryId | string | *No description.* | +| ReplicationConfiguration | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`AttrRegistryId\`Required +##### \`AttrRegistryId\`Required \`\`\`csharp public string AttrRegistryId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`ReplicationConfiguration\`Required +##### \`ReplicationConfiguration\`Required \`\`\`csharp public object ReplicationConfiguration { get; } @@ -3075,31 +3099,35 @@ public object ReplicationConfiguration { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3109,102 +3137,102 @@ new CfnRepository(Construct Scope, string Id, CfnRepositoryProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnrepositoryparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.CfnRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnRepositoryProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnRepositoryProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnRepositoryProps) +- *Type:* CfnRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsecrcfnrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrRepositoryUri\`](#amazoncdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsecrcfnrepositorypropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`EncryptionConfiguration\`](#amazoncdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`ImageScanningConfiguration\`](#amazoncdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`ImageTagMutability\`](#amazoncdkawsecrcfnrepositorypropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`LifecyclePolicy\`](#amazoncdkawsecrcfnrepositorypropertylifecyclepolicy) | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | +| AttrArn | string | *No description.* | +| AttrRepositoryUri | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::ECR::Repository.Tags\`. | +| EncryptionConfiguration | object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| ImageScanningConfiguration | object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| RepositoryPolicyText | object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| ImageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| LifecyclePolicy | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| RepositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrRepositoryUri\`Required +##### \`AttrRepositoryUri\`Required \`\`\`csharp public string AttrRepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::ECR::Repository.Tags\`. @@ -3212,13 +3240,13 @@ public TagManager Tags { get; } --- -##### \`EncryptionConfiguration\`Required +##### \`EncryptionConfiguration\`Required \`\`\`csharp public object EncryptionConfiguration { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -3226,13 +3254,13 @@ public object EncryptionConfiguration { get; } --- -##### \`ImageScanningConfiguration\`Required +##### \`ImageScanningConfiguration\`Required \`\`\`csharp public object ImageScanningConfiguration { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -3240,13 +3268,13 @@ public object ImageScanningConfiguration { get; } --- -##### \`RepositoryPolicyText\`Required +##### \`RepositoryPolicyText\`Required \`\`\`csharp public object RepositoryPolicyText { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -3254,13 +3282,13 @@ public object RepositoryPolicyText { get; } --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public string ImageTagMutability { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -3268,7 +3296,7 @@ public string ImageTagMutability { get; } --- -##### \`LifecyclePolicy\`Optional +##### \`LifecyclePolicy\`Optional \`\`\`csharp public object LifecyclePolicy { get; } @@ -3282,13 +3310,13 @@ public object LifecyclePolicy { get; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -3296,27 +3324,31 @@ public string RepositoryName { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3326,75 +3358,75 @@ new Repository(Construct Scope, string Id, RepositoryProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrrepositoryparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsecrrepositoryparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsecrrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.RepositoryProps\`](#Amazon.CDK.AWS.ECR.RepositoryProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | RepositoryProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.RepositoryProps\`](#Amazon.CDK.AWS.ECR.RepositoryProps) +- *Type:* RepositoryProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddLifecycleRule\`](#amazoncdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| AddLifecycleRule | Add a life cycle rule to the repository. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`AddLifecycleRule\` +##### \`AddLifecycleRule\` \`\`\`csharp private AddLifecycleRule(LifecycleRule Rule) \`\`\` -###### \`Rule\`Required +###### \`Rule\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule) +- *Type:* LifecycleRule --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`ArnForLocalRepository\`](#amazoncdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`FromRepositoryArn\`](#amazoncdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`FromRepositoryAttributes\`](#amazoncdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`FromRepositoryName\`](#amazoncdkawsecrrepositoryfromrepositoryname) | *No description.* | +| ArnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| FromRepositoryArn | *No description.* | +| FromRepositoryAttributes | Import a repository. | +| FromRepositoryName | *No description.* | --- -##### \`ArnForLocalRepository\` +##### \`ArnForLocalRepository\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3402,25 +3434,25 @@ using Amazon.CDK.AWS.ECR; Repository.ArnForLocalRepository(string RepositoryName, IConstruct Scope, string Account = null); \`\`\` -###### \`RepositoryName\`Required +###### \`RepositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.IConstruct\`](#Constructs.IConstruct) +- *Type:* Constructs.IConstruct --- -###### \`Account\`Optional +###### \`Account\`Optional -- *Type:* \`string\` +- *Type:* string --- -##### \`FromRepositoryArn\` +##### \`FromRepositoryArn\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3428,25 +3460,25 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryArn(Construct Scope, string Id, string RepositoryArn); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`RepositoryArn\`Required +###### \`RepositoryArn\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`FromRepositoryAttributes\` +##### \`FromRepositoryAttributes\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3454,25 +3486,25 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryAttributes(Construct Scope, string Id, RepositoryAttributes Attrs); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Attrs\`Required +###### \`Attrs\`Required -- *Type:* [\`Amazon.CDK.AWS.ECR.RepositoryAttributes\`](#Amazon.CDK.AWS.ECR.RepositoryAttributes) +- *Type:* RepositoryAttributes --- -##### \`FromRepositoryName\` +##### \`FromRepositoryName\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3480,67 +3512,67 @@ using Amazon.CDK.AWS.ECR; Repository.FromRepositoryName(Construct Scope, string Id, string RepositoryName); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`RepositoryName\`Required +###### \`RepositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`Amazon.CDK.AWS.ECR.IRepository\`](#Amazon.CDK.AWS.ECR.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3550,255 +3582,255 @@ new RepositoryBase(Construct Scope, string Id, ResourceProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrrepositorybaseparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsecrrepositorybaseparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsecrrepositorybaseparameterprops) | [\`Amazon.CDK.ResourceProps\`](#Amazon.CDK.ResourceProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.ResourceProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.ResourceProps\`](#Amazon.CDK.ResourceProps) +- *Type:* Amazon.CDK.ResourceProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`Grant\`](#amazoncdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`GrantPull\`](#amazoncdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`GrantPullPush\`](#amazoncdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`OnCloudTrailEvent\`](#amazoncdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`OnCloudTrailImagePushed\`](#amazoncdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`OnEvent\`](#amazoncdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`OnImageScanCompleted\`](#amazoncdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`RepositoryUriForDigest\`](#amazoncdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`RepositoryUriForTag\`](#amazoncdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | +| Grant | Grant the given principal identity permissions to perform the actions on this repository. | +| GrantPull | Grant the given identity permissions to use the images in this repository. | +| GrantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| OnCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| OnCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| OnEvent | Defines a CloudWatch event rule which triggers for repository events. | +| OnImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| RepositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| RepositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -##### \`Grant\` +##### \`Grant\` \`\`\`csharp private Grant(IGrantable Grantee, string Actions) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -###### \`Actions\`Required +###### \`Actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`GrantPull\` +##### \`GrantPull\` \`\`\`csharp private GrantPull(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`GrantPullPush\` +##### \`GrantPullPush\` \`\`\`csharp private GrantPullPush(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`OnCloudTrailEvent\` +##### \`OnCloudTrailEvent\` \`\`\`csharp private OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- -##### \`OnCloudTrailImagePushed\` +##### \`OnCloudTrailImagePushed\` \`\`\`csharp private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions\`](#Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`OnEvent\` +##### \`OnEvent\` \`\`\`csharp private OnEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- -##### \`OnImageScanCompleted\` +##### \`OnImageScanCompleted\` \`\`\`csharp private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions\`](#Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`RepositoryUriForDigest\` +##### \`RepositoryUriForDigest\` \`\`\`csharp private RepositoryUriForDigest(string Digest = null) \`\`\` -###### \`Digest\`Optional +###### \`Digest\`Optional -- *Type:* \`string\` +- *Type:* string Optional image digest. --- -##### \`RepositoryUriForTag\` +##### \`RepositoryUriForTag\` \`\`\`csharp private RepositoryUriForTag(string Tag = null) \`\`\` -###### \`Tag\`Optional +###### \`Tag\`Optional -- *Type:* \`string\` +- *Type:* string Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositorybasepropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorybasepropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`RepositoryUri\`](#amazoncdkawsecrrepositorybasepropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | +| RepositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`RepositoryUri\`Required +##### \`RepositoryUri\`Required \`\`\`csharp public string RepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -3807,15 +3839,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3828,24 +3860,24 @@ new CfnPublicRepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryCatalogData\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`Tags\`](#amazoncdkawsecrcfnpublicrepositorypropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| RepositoryCatalogData | object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| RepositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| RepositoryPolicyText | object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`RepositoryCatalogData\`Optional +##### \`RepositoryCatalogData\`Optional \`\`\`csharp public object RepositoryCatalogData { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -3853,13 +3885,13 @@ public object RepositoryCatalogData { get; set; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -3867,13 +3899,13 @@ public string RepositoryName { get; set; } --- -##### \`RepositoryPolicyText\`Optional +##### \`RepositoryPolicyText\`Optional \`\`\`csharp public object RepositoryPolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -3881,13 +3913,13 @@ public object RepositoryPolicyText { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. @@ -3895,13 +3927,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3911,21 +3943,21 @@ new CfnRegistryPolicyProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PolicyText\`](#amazoncdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| PolicyText | object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`PolicyText\`Required +##### \`PolicyText\`Required \`\`\`csharp public object PolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -3933,13 +3965,13 @@ public object PolicyText { get; set; } --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3949,15 +3981,15 @@ new CfnReplicationConfigurationProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ReplicationConfiguration\`](#amazoncdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| ReplicationConfiguration | object | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`ReplicationConfiguration\`Required +##### \`ReplicationConfiguration\`Required \`\`\`csharp public object ReplicationConfiguration { get; set; } @@ -3971,13 +4003,13 @@ public object ReplicationConfiguration { get; set; } --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -3993,27 +4025,27 @@ new CfnRepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`EncryptionConfiguration\`](#amazoncdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`ImageScanningConfiguration\`](#amazoncdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`ImageTagMutability\`](#amazoncdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`LifecyclePolicy\`](#amazoncdkawsecrcfnrepositorypropspropertylifecyclepolicy) | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`Tags\`](#amazoncdkawsecrcfnrepositorypropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::ECR::Repository.Tags\`. | +| EncryptionConfiguration | object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| ImageScanningConfiguration | object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| ImageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| LifecyclePolicy | object | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| RepositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | +| RepositoryPolicyText | object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`EncryptionConfiguration\`Optional +##### \`EncryptionConfiguration\`Optional \`\`\`csharp public object EncryptionConfiguration { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -4021,13 +4053,13 @@ public object EncryptionConfiguration { get; set; } --- -##### \`ImageScanningConfiguration\`Optional +##### \`ImageScanningConfiguration\`Optional \`\`\`csharp public object ImageScanningConfiguration { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -4035,13 +4067,13 @@ public object ImageScanningConfiguration { get; set; } --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public string ImageTagMutability { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -4049,7 +4081,7 @@ public string ImageTagMutability { get; set; } --- -##### \`LifecyclePolicy\`Optional +##### \`LifecyclePolicy\`Optional \`\`\`csharp public object LifecyclePolicy { get; set; } @@ -4063,13 +4095,13 @@ public object LifecyclePolicy { get; set; } --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -4077,13 +4109,13 @@ public string RepositoryName { get; set; } --- -##### \`RepositoryPolicyText\`Optional +##### \`RepositoryPolicyText\`Optional \`\`\`csharp public object RepositoryPolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -4091,13 +4123,13 @@ public object RepositoryPolicyText { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::ECR::Repository.Tags\`. @@ -4105,11 +4137,11 @@ public CfnTag[] Tags { get; set; } --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4120,22 +4152,22 @@ new LifecyclePolicyProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`LifecyclePolicyText\`](#amazoncdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`RegistryId\`](#amazoncdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| LifecyclePolicyText | string | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| RegistryId | string | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`LifecyclePolicyText\`Optional +##### \`LifecyclePolicyText\`Optional \`\`\`csharp public string LifecyclePolicyText { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -4143,13 +4175,13 @@ public string LifecyclePolicyText { get; set; } --- -##### \`RegistryId\`Optional +##### \`RegistryId\`Optional \`\`\`csharp public string RegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -4157,11 +4189,11 @@ public string RegistryId { get; set; } --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4176,39 +4208,39 @@ new LifecycleRule { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecrlifecyclerulepropertydescription) | \`string\` | Describes the purpose of the rule. | -| [\`MaxImageAge\`](#amazoncdkawsecrlifecyclerulepropertymaximageage) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`MaxImageCount\`](#amazoncdkawsecrlifecyclerulepropertymaximagecount) | \`double\` | The maximum number of images to retain. | -| [\`RulePriority\`](#amazoncdkawsecrlifecyclerulepropertyrulepriority) | \`double\` | Controls the order in which rules are evaluated (low to high). | -| [\`TagPrefixList\`](#amazoncdkawsecrlifecyclerulepropertytagprefixlist) | \`string\`[] | Select images that have ALL the given prefixes in their tag. | -| [\`TagStatus\`](#amazoncdkawsecrlifecyclerulepropertytagstatus) | [\`Amazon.CDK.AWS.ECR.TagStatus\`](#Amazon.CDK.AWS.ECR.TagStatus) | Select images based on tags. | +| Description | string | Describes the purpose of the rule. | +| MaxImageAge | Amazon.CDK.Duration | The maximum age of images to retain. The value must represent a number of days. | +| MaxImageCount | double | The maximum number of images to retain. | +| RulePriority | double | Controls the order in which rules are evaluated (low to high). | +| TagPrefixList | string[] | Select images that have ALL the given prefixes in their tag. | +| TagStatus | TagStatus | Select images based on tags. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description Describes the purpose of the rule. --- -##### \`MaxImageAge\`Optional +##### \`MaxImageAge\`Optional \`\`\`csharp public Duration MaxImageAge { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration The maximum age of images to retain. The value must represent a number of days. @@ -4216,13 +4248,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`MaxImageCount\`Optional +##### \`MaxImageCount\`Optional \`\`\`csharp public double MaxImageCount { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double The maximum number of images to retain. @@ -4230,13 +4262,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`RulePriority\`Optional +##### \`RulePriority\`Optional \`\`\`csharp public double RulePriority { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -4245,13 +4277,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`TagPrefixList\`Optional +##### \`TagPrefixList\`Optional \`\`\`csharp public string[] TagPrefixList { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] Select images that have ALL the given prefixes in their tag. @@ -4259,13 +4291,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`TagStatus\`Optional +##### \`TagStatus\`Optional \`\`\`csharp public TagStatus TagStatus { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.TagStatus\`](#Amazon.CDK.AWS.ECR.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -4274,11 +4306,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4292,92 +4324,92 @@ new OnCloudTrailImagePushedOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`EventPattern\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`RuleName\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`Target\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) | The target to register for the event. | -| [\`ImageTag\`](#amazoncdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`string\` | Only watch changes to this image tag. | +| Description | string | A description of the rule's purpose. | +| EventPattern | Amazon.CDK.AWS.Events.EventPattern | Additional restrictions for the event to route to the specified target. | +| RuleName | string | A name for the rule. | +| Target | Amazon.CDK.AWS.Events.IRuleTarget | The target to register for the event. | +| ImageTag | string | Only watch changes to this image tag. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`EventPattern\`Optional +##### \`EventPattern\`Optional \`\`\`csharp public EventPattern EventPattern { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) +- *Type:* Amazon.CDK.AWS.Events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`RuleName\`Optional +##### \`RuleName\`Optional \`\`\`csharp public string RuleName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`Target\`Optional +##### \`Target\`Optional \`\`\`csharp public IRuleTarget Target { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) +- *Type:* Amazon.CDK.AWS.Events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`ImageTag\`Optional +##### \`ImageTag\`Optional \`\`\`csharp public string ImageTag { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4391,81 +4423,81 @@ new OnImageScanCompletedOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Description\`](#amazoncdkawsecronimagescancompletedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`EventPattern\`](#amazoncdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`RuleName\`](#amazoncdkawsecronimagescancompletedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`Target\`](#amazoncdkawsecronimagescancompletedoptionspropertytarget) | [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) | The target to register for the event. | -| [\`ImageTags\`](#amazoncdkawsecronimagescancompletedoptionspropertyimagetags) | \`string\`[] | Only watch changes to the image tags spedified. | +| Description | string | A description of the rule's purpose. | +| EventPattern | Amazon.CDK.AWS.Events.EventPattern | Additional restrictions for the event to route to the specified target. | +| RuleName | string | A name for the rule. | +| Target | Amazon.CDK.AWS.Events.IRuleTarget | The target to register for the event. | +| ImageTags | string[] | Only watch changes to the image tags spedified. | --- -##### \`Description\`Optional +##### \`Description\`Optional \`\`\`csharp public string Description { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`EventPattern\`Optional +##### \`EventPattern\`Optional \`\`\`csharp public EventPattern EventPattern { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.EventPattern\`](#Amazon.CDK.AWS.Events.EventPattern) +- *Type:* Amazon.CDK.AWS.Events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`RuleName\`Optional +##### \`RuleName\`Optional \`\`\`csharp public string RuleName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`Target\`Optional +##### \`Target\`Optional \`\`\`csharp public IRuleTarget Target { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.Events.IRuleTarget\`](#Amazon.CDK.AWS.Events.IRuleTarget) +- *Type:* Amazon.CDK.AWS.Events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`ImageTags\`Optional +##### \`ImageTags\`Optional \`\`\`csharp public string[] ImageTags { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -4474,11 +4506,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4488,15 +4520,15 @@ new ReplicationConfigurationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Rules\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | object | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| Rules | object | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`Rules\`Required +##### \`Rules\`Required \`\`\`csharp public object Rules { get; set; } @@ -4510,11 +4542,11 @@ public object Rules { get; set; } --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4525,22 +4557,22 @@ new ReplicationDestinationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Region\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`RegistryId\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| Region | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| RegistryId | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`Region\`Required +##### \`Region\`Required \`\`\`csharp public string Region { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -4548,13 +4580,13 @@ public string Region { get; set; } --- -##### \`RegistryId\`Required +##### \`RegistryId\`Required \`\`\`csharp public string RegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -4562,11 +4594,11 @@ public string RegistryId { get; set; } --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4576,15 +4608,15 @@ new ReplicationRuleProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Destinations\`](#amazoncdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | object | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| Destinations | object | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`Destinations\`Required +##### \`Destinations\`Required \`\`\`csharp public object Destinations { get; set; } @@ -4598,9 +4630,9 @@ public object Destinations { get; set; } --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4611,38 +4643,38 @@ new RepositoryAttributes { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryArn\`](#amazoncdkawsecrrepositoryattributespropertyrepositoryarn)* | \`string\` | *No description.* | -| [\`RepositoryName\`](#amazoncdkawsecrrepositoryattributespropertyrepositoryname)* | \`string\` | *No description.* | +| RepositoryArn | string | *No description.* | +| RepositoryName | string | *No description.* | --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4657,39 +4689,39 @@ new RepositoryProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ImageScanOnPush\`](#amazoncdkawsecrrepositorypropspropertyimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`ImageTagMutability\`](#amazoncdkawsecrrepositorypropspropertyimagetagmutability) | [\`Amazon.CDK.AWS.ECR.TagMutability\`](#Amazon.CDK.AWS.ECR.TagMutability) | The tag mutability setting for the repository. | -| [\`LifecycleRegistryId\`](#amazoncdkawsecrrepositorypropspropertylifecycleregistryid) | \`string\` | The AWS account ID associated with the registry that contains the repository. | -| [\`LifecycleRules\`](#amazoncdkawsecrrepositorypropspropertylifecyclerules) | [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule)[] | Life cycle rules to apply to this registry. | -| [\`RemovalPolicy\`](#amazoncdkawsecrrepositorypropspropertyremovalpolicy) | [\`Amazon.CDK.RemovalPolicy\`](#Amazon.CDK.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`RepositoryName\`](#amazoncdkawsecrrepositorypropspropertyrepositoryname) | \`string\` | Name for this repository. | +| ImageScanOnPush | bool | Enable the scan on push when creating the repository. | +| ImageTagMutability | TagMutability | The tag mutability setting for the repository. | +| LifecycleRegistryId | string | The AWS account ID associated with the registry that contains the repository. | +| LifecycleRules | LifecycleRule[] | Life cycle rules to apply to this registry. | +| RemovalPolicy | Amazon.CDK.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| RepositoryName | string | Name for this repository. | --- -##### \`ImageScanOnPush\`Optional +##### \`ImageScanOnPush\`Optional \`\`\`csharp public bool ImageScanOnPush { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`ImageTagMutability\`Optional +##### \`ImageTagMutability\`Optional \`\`\`csharp public TagMutability ImageTagMutability { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.TagMutability\`](#Amazon.CDK.AWS.ECR.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -4698,78 +4730,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`LifecycleRegistryId\`Optional +##### \`LifecycleRegistryId\`Optional \`\`\`csharp public string LifecycleRegistryId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`LifecycleRules\`Optional +##### \`LifecycleRules\`Optional \`\`\`csharp public LifecycleRule[] LifecycleRules { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.AWS.ECR.LifecycleRule\`](#Amazon.CDK.AWS.ECR.LifecycleRule)[] +- *Type:* LifecycleRule[] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`RemovalPolicy\`Optional +##### \`RemovalPolicy\`Optional \`\`\`csharp public RemovalPolicy RemovalPolicy { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.RemovalPolicy\`](#Amazon.CDK.RemovalPolicy) +- *Type:* Amazon.CDK.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`RepositoryName\`Optional +##### \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`GrantRead\`](#amazoncdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| GrantRead | Grant access to retrieve an authorization token. | --- -##### \`GrantRead\` +##### \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4777,30 +4809,30 @@ using Amazon.CDK.AWS.ECR; AuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`GrantRead\`](#amazoncdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| GrantRead | Grant access to retrieve an authorization token. | --- -##### \`GrantRead\` +##### \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -4808,239 +4840,239 @@ using Amazon.CDK.AWS.ECR; PublicGalleryAuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource) +- *Extends:* Amazon.CDK.IResource -- *Implemented By:* [\`Amazon.CDK.AWS.ECR.Repository\`](#Amazon.CDK.AWS.ECR.Repository), [\`Amazon.CDK.AWS.ECR.RepositoryBase\`](#Amazon.CDK.AWS.ECR.RepositoryBase), [\`Amazon.CDK.AWS.ECR.IRepository\`](#Amazon.CDK.AWS.ECR.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`Grant\`](#amazoncdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`GrantPull\`](#amazoncdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`GrantPullPush\`](#amazoncdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`OnCloudTrailEvent\`](#amazoncdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`OnCloudTrailImagePushed\`](#amazoncdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`OnEvent\`](#amazoncdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`OnImageScanCompleted\`](#amazoncdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`RepositoryUriForDigest\`](#amazoncdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`RepositoryUriForTag\`](#amazoncdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | +| Grant | Grant the given principal identity permissions to perform the actions on this repository. | +| GrantPull | Grant the given identity permissions to pull images in this repository. | +| GrantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| OnCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| OnCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| OnEvent | Defines a CloudWatch event rule which triggers for repository events. | +| OnImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| RepositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| RepositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`AddToResourcePolicy\` +##### \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -##### \`Grant\` +##### \`Grant\` \`\`\`csharp private Grant(IGrantable Grantee, string Actions) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -###### \`Actions\`Required +###### \`Actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`GrantPull\` +##### \`GrantPull\` \`\`\`csharp private GrantPull(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`GrantPullPush\` +##### \`GrantPullPush\` \`\`\`csharp private GrantPullPush(IGrantable Grantee) \`\`\` -###### \`Grantee\`Required +###### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -##### \`OnCloudTrailEvent\` +##### \`OnCloudTrailEvent\` \`\`\`csharp private OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- -##### \`OnCloudTrailImagePushed\` +##### \`OnCloudTrailImagePushed\` \`\`\`csharp private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions\`](#Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`OnEvent\` +##### \`OnEvent\` \`\`\`csharp private OnEvent(string Id, OnEventOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- -##### \`OnImageScanCompleted\` +##### \`OnImageScanCompleted\` \`\`\`csharp private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions\`](#Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`RepositoryUriForDigest\` +##### \`RepositoryUriForDigest\` \`\`\`csharp private RepositoryUriForDigest(string Digest = null) \`\`\` -###### \`Digest\`Optional +###### \`Digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`RepositoryUriForTag\` +##### \`RepositoryUriForTag\` \`\`\`csharp private RepositoryUriForTag(string Tag = null) \`\`\` -###### \`Tag\`Optional +###### \`Tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawsecrirepositorypropertynode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct tree node for this construct. | -| [\`Env\`](#amazoncdkawsecrirepositorypropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawsecrirepositorypropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`RepositoryArn\`](#amazoncdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`RepositoryUri\`](#amazoncdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| Node | Amazon.CDK.ConstructNode | The construct tree node for this construct. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | +| RepositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public ConstructNode Node { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -5048,49 +5080,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`RepositoryArn\`Required +##### \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`RepositoryName\`Required +##### \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`RepositoryUri\`Required +##### \`RepositoryUri\`Required \`\`\`csharp public string RepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -5098,60 +5130,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#amazoncdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#amazoncdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#amazoncdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#amazoncdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#amazoncdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -6374,15 +6406,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -6392,116 +6424,116 @@ new AwsAuth(Construct Scope, string Id, AwsAuthProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksawsauthparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksawsauthparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksawsauthparameterprops)* | [\`Amazon.CDK.aws_eks.AwsAuthProps\`](#Amazon.CDK.aws_eks.AwsAuthProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.AwsAuthProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthProps\`](#Amazon.CDK.aws_eks.AwsAuthProps) +- *Type:* Amazon.CDK.aws_eks.AwsAuthProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddAccount\`](#amazoncdkawseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`AddMastersRole\`](#amazoncdkawseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`AddRoleMapping\`](#amazoncdkawseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`AddUserMapping\`](#amazoncdkawseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| AddAccount | Additional AWS account to add to the aws-auth configmap. | +| AddMastersRole | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| AddRoleMapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| AddUserMapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`AddAccount\` +##### \`AddAccount\` \`\`\`csharp private AddAccount(string AccountId) \`\`\` -###### \`AccountId\`Required +###### \`AccountId\`Required -- *Type:* \`string\` +- *Type:* string account number. --- -##### \`AddMastersRole\` +##### \`AddMastersRole\` \`\`\`csharp private AddMastersRole(IRole Role, string Username = null) \`\`\` -###### \`Role\`Required +###### \`Role\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The IAM role to add. --- -###### \`Username\`Optional +###### \`Username\`Optional -- *Type:* \`string\` +- *Type:* string Optional user (defaults to the role ARN). --- -##### \`AddRoleMapping\` +##### \`AddRoleMapping\` \`\`\`csharp private AddRoleMapping(IRole Role, AwsAuthMapping Mapping) \`\`\` -###### \`Role\`Required +###### \`Role\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The IAM role to map. --- -###### \`Mapping\`Required +###### \`Mapping\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthMapping\`](#Amazon.CDK.aws_eks.AwsAuthMapping) +- *Type:* Amazon.CDK.aws_eks.AwsAuthMapping Mapping to k8s user name and groups. --- -##### \`AddUserMapping\` +##### \`AddUserMapping\` \`\`\`csharp private AddUserMapping(IUser User, AwsAuthMapping Mapping) \`\`\` -###### \`User\`Required +###### \`User\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IUser\`](#Amazon.CDK.aws_iam.IUser) +- *Type:* Amazon.CDK.aws_iam.IUser The IAM user to map. --- -###### \`Mapping\`Required +###### \`Mapping\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthMapping\`](#Amazon.CDK.aws_eks.AwsAuthMapping) +- *Type:* Amazon.CDK.aws_eks.AwsAuthMapping Mapping to k8s user name and groups. @@ -6510,15 +6542,15 @@ Mapping to k8s user name and groups. -### CfnAddon +### CfnAddon -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -6528,90 +6560,90 @@ new CfnAddon(Construct Scope, string Id, CfnAddonProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnaddonparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnaddonparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnaddonparameterprops)* | [\`Amazon.CDK.aws_eks.CfnAddonProps\`](#Amazon.CDK.aws_eks.CfnAddonProps) | resource properties. | +| Scope | Constructs.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnAddonProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnAddonProps\`](#Amazon.CDK.aws_eks.CfnAddonProps) +- *Type:* Amazon.CDK.aws_eks.CfnAddonProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnaddonpropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnaddonpropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`AddonName\`](#amazoncdkawsekscfnaddonpropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnaddonpropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`AddonVersion\`](#amazoncdkawsekscfnaddonpropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`ResolveConflicts\`](#amazoncdkawsekscfnaddonpropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`ServiceAccountRoleArn\`](#amazoncdkawsekscfnaddonpropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::Addon.Tags\`. | +| AddonName | string | \`AWS::EKS::Addon.AddonName\`. | +| ClusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| AddonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| ResolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| ServiceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::Addon.Tags\`. @@ -6619,13 +6651,13 @@ public TagManager Tags { get; } --- -##### \`AddonName\`Required +##### \`AddonName\`Required \`\`\`csharp public string AddonName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -6633,13 +6665,13 @@ public string AddonName { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -6647,13 +6679,13 @@ public string ClusterName { get; } --- -##### \`AddonVersion\`Optional +##### \`AddonVersion\`Optional \`\`\`csharp public string AddonVersion { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -6661,13 +6693,13 @@ public string AddonVersion { get; } --- -##### \`ResolveConflicts\`Optional +##### \`ResolveConflicts\`Optional \`\`\`csharp public string ResolveConflicts { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -6675,13 +6707,13 @@ public string ResolveConflicts { get; } --- -##### \`ServiceAccountRoleArn\`Optional +##### \`ServiceAccountRoleArn\`Optional \`\`\`csharp public string ServiceAccountRoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -6689,31 +6721,35 @@ public string ServiceAccountRoleArn { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnaddonpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -6723,139 +6759,139 @@ new CfnCluster(Construct Scope, string Id, CfnClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnclusterparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnclusterparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnclusterparameterprops)* | [\`Amazon.CDK.aws_eks.CfnClusterProps\`](#Amazon.CDK.aws_eks.CfnClusterProps) | resource properties. | +| Scope | Constructs.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnClusterProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnClusterProps\`](#Amazon.CDK.aws_eks.CfnClusterProps) +- *Type:* Amazon.CDK.aws_eks.CfnClusterProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnclusterpropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrCertificateAuthorityData\`](#amazoncdkawsekscfnclusterpropertyattrcertificateauthoritydata)* | \`string\` | *No description.* | -| [\`AttrClusterSecurityGroupId\`](#amazoncdkawsekscfnclusterpropertyattrclustersecuritygroupid)* | \`string\` | *No description.* | -| [\`AttrEncryptionConfigKeyArn\`](#amazoncdkawsekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`string\` | *No description.* | -| [\`AttrEndpoint\`](#amazoncdkawsekscfnclusterpropertyattrendpoint)* | \`string\` | *No description.* | -| [\`AttrOpenIdConnectIssuerUrl\`](#amazoncdkawsekscfnclusterpropertyattropenidconnectissuerurl)* | \`string\` | *No description.* | -| [\`ResourcesVpcConfig\`](#amazoncdkawsekscfnclusterpropertyresourcesvpcconfig)* | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`RoleArn\`](#amazoncdkawsekscfnclusterpropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`EncryptionConfig\`](#amazoncdkawsekscfnclusterpropertyencryptionconfig) | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`KubernetesNetworkConfig\`](#amazoncdkawsekscfnclusterpropertykubernetesnetworkconfig) | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`Name\`](#amazoncdkawsekscfnclusterpropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnclusterpropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| AttrArn | string | *No description.* | +| AttrCertificateAuthorityData | string | *No description.* | +| AttrClusterSecurityGroupId | string | *No description.* | +| AttrEncryptionConfigKeyArn | string | *No description.* | +| AttrEndpoint | string | *No description.* | +| AttrOpenIdConnectIssuerUrl | string | *No description.* | +| ResourcesVpcConfig | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| RoleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| EncryptionConfig | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| KubernetesNetworkConfig | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| Name | string | \`AWS::EKS::Cluster.Name\`. | +| Version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrCertificateAuthorityData\`Required +##### \`AttrCertificateAuthorityData\`Required \`\`\`csharp public string AttrCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrClusterSecurityGroupId\`Required +##### \`AttrClusterSecurityGroupId\`Required \`\`\`csharp public string AttrClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrEncryptionConfigKeyArn\`Required +##### \`AttrEncryptionConfigKeyArn\`Required \`\`\`csharp public string AttrEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrEndpoint\`Required +##### \`AttrEndpoint\`Required \`\`\`csharp public string AttrEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrOpenIdConnectIssuerUrl\`Required +##### \`AttrOpenIdConnectIssuerUrl\`Required \`\`\`csharp public string AttrOpenIdConnectIssuerUrl { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`ResourcesVpcConfig\`Required +##### \`ResourcesVpcConfig\`Required \`\`\`csharp public object ResourcesVpcConfig { get; } @@ -6869,13 +6905,13 @@ public object ResourcesVpcConfig { get; } --- -##### \`RoleArn\`Required +##### \`RoleArn\`Required \`\`\`csharp public string RoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -6883,7 +6919,7 @@ public string RoleArn { get; } --- -##### \`EncryptionConfig\`Optional +##### \`EncryptionConfig\`Optional \`\`\`csharp public object EncryptionConfig { get; } @@ -6897,7 +6933,7 @@ public object EncryptionConfig { get; } --- -##### \`KubernetesNetworkConfig\`Optional +##### \`KubernetesNetworkConfig\`Optional \`\`\`csharp public object KubernetesNetworkConfig { get; } @@ -6911,13 +6947,13 @@ public object KubernetesNetworkConfig { get; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -6925,13 +6961,13 @@ public string Name { get; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -6939,31 +6975,35 @@ public string Version { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnclusterpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -6973,90 +7013,90 @@ new CfnFargateProfile(Construct Scope, string Id, CfnFargateProfileProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnfargateprofileparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnfargateprofileparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnfargateprofileparameterprops)* | [\`Amazon.CDK.aws_eks.CfnFargateProfileProps\`](#Amazon.CDK.aws_eks.CfnFargateProfileProps) | resource properties. | +| Scope | Constructs.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnFargateProfileProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnFargateProfileProps\`](#Amazon.CDK.aws_eks.CfnFargateProfileProps) +- *Type:* Amazon.CDK.aws_eks.CfnFargateProfileProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnfargateprofilepropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnfargateprofilepropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnfargateprofilepropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`PodExecutionRoleArn\`](#amazoncdkawsekscfnfargateprofilepropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`Selectors\`](#amazoncdkawsekscfnfargateprofilepropertyselectors)* | object | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`FargateProfileName\`](#amazoncdkawsekscfnfargateprofilepropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`Subnets\`](#amazoncdkawsekscfnfargateprofilepropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| ClusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| PodExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| Selectors | object | \`AWS::EKS::FargateProfile.Selectors\`. | +| FargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| Subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -7064,13 +7104,13 @@ public TagManager Tags { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -7078,13 +7118,13 @@ public string ClusterName { get; } --- -##### \`PodExecutionRoleArn\`Required +##### \`PodExecutionRoleArn\`Required \`\`\`csharp public string PodExecutionRoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -7092,7 +7132,7 @@ public string PodExecutionRoleArn { get; } --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public object Selectors { get; } @@ -7106,13 +7146,13 @@ public object Selectors { get; } --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -7120,13 +7160,13 @@ public string FargateProfileName { get; } --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public string[] Subnets { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -7134,31 +7174,35 @@ public string[] Subnets { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnfargateprofilepropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -7168,123 +7212,123 @@ new CfnNodegroup(Construct Scope, string Id, CfnNodegroupProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnnodegroupparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnnodegroupparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnnodegroupparameterprops)* | [\`Amazon.CDK.aws_eks.CfnNodegroupProps\`](#Amazon.CDK.aws_eks.CfnNodegroupProps) | resource properties. | +| Scope | Constructs.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnNodegroupProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnNodegroupProps\`](#Amazon.CDK.aws_eks.CfnNodegroupProps) +- *Type:* Amazon.CDK.aws_eks.CfnNodegroupProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnnodegrouppropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrClusterName\`](#amazoncdkawsekscfnnodegrouppropertyattrclustername)* | \`string\` | *No description.* | -| [\`AttrNodegroupName\`](#amazoncdkawsekscfnnodegrouppropertyattrnodegroupname)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnnodegrouppropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnnodegrouppropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`Labels\`](#amazoncdkawsekscfnnodegrouppropertylabels)* | \`object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`NodeRole\`](#amazoncdkawsekscfnnodegrouppropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`Subnets\`](#amazoncdkawsekscfnnodegrouppropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`AmiType\`](#amazoncdkawsekscfnnodegrouppropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`CapacityType\`](#amazoncdkawsekscfnnodegrouppropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`DiskSize\`](#amazoncdkawsekscfnnodegrouppropertydisksize) | \`double\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`ForceUpdateEnabled\`](#amazoncdkawsekscfnnodegrouppropertyforceupdateenabled) | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`InstanceTypes\`](#amazoncdkawsekscfnnodegrouppropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`LaunchTemplate\`](#amazoncdkawsekscfnnodegrouppropertylaunchtemplate) | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`NodegroupName\`](#amazoncdkawsekscfnnodegrouppropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`ReleaseVersion\`](#amazoncdkawsekscfnnodegrouppropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`RemoteAccess\`](#amazoncdkawsekscfnnodegrouppropertyremoteaccess) | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`ScalingConfig\`](#amazoncdkawsekscfnnodegrouppropertyscalingconfig) | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`Taints\`](#amazoncdkawsekscfnnodegrouppropertytaints) | object | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouppropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| AttrArn | string | *No description.* | +| AttrClusterName | string | *No description.* | +| AttrNodegroupName | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| ClusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| Labels | object | \`AWS::EKS::Nodegroup.Labels\`. | +| NodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| Subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| AmiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| CapacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| DiskSize | double | \`AWS::EKS::Nodegroup.DiskSize\`. | +| ForceUpdateEnabled | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| InstanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| LaunchTemplate | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| NodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| ReleaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| RemoteAccess | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| ScalingConfig | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| Taints | object | \`AWS::EKS::Nodegroup.Taints\`. | +| Version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrClusterName\`Required +##### \`AttrClusterName\`Required \`\`\`csharp public string AttrClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrNodegroupName\`Required +##### \`AttrNodegroupName\`Required \`\`\`csharp public string AttrNodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -7292,13 +7336,13 @@ public TagManager Tags { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -7306,13 +7350,13 @@ public string ClusterName { get; } --- -##### \`Labels\`Required +##### \`Labels\`Required \`\`\`csharp public object Labels { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Labels\`. @@ -7320,13 +7364,13 @@ public object Labels { get; } --- -##### \`NodeRole\`Required +##### \`NodeRole\`Required \`\`\`csharp public string NodeRole { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -7334,13 +7378,13 @@ public string NodeRole { get; } --- -##### \`Subnets\`Required +##### \`Subnets\`Required \`\`\`csharp public string[] Subnets { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -7348,13 +7392,13 @@ public string[] Subnets { get; } --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public string AmiType { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -7362,13 +7406,13 @@ public string AmiType { get; } --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public string CapacityType { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -7376,13 +7420,13 @@ public string CapacityType { get; } --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`AWS::EKS::Nodegroup.DiskSize\`. @@ -7390,7 +7434,7 @@ public double DiskSize { get; } --- -##### \`ForceUpdateEnabled\`Optional +##### \`ForceUpdateEnabled\`Optional \`\`\`csharp public object ForceUpdateEnabled { get; } @@ -7404,13 +7448,13 @@ public object ForceUpdateEnabled { get; } --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public string[] InstanceTypes { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -7418,7 +7462,7 @@ public string[] InstanceTypes { get; } --- -##### \`LaunchTemplate\`Optional +##### \`LaunchTemplate\`Optional \`\`\`csharp public object LaunchTemplate { get; } @@ -7432,13 +7476,13 @@ public object LaunchTemplate { get; } --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -7446,13 +7490,13 @@ public string NodegroupName { get; } --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -7460,7 +7504,7 @@ public string ReleaseVersion { get; } --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public object RemoteAccess { get; } @@ -7474,7 +7518,7 @@ public object RemoteAccess { get; } --- -##### \`ScalingConfig\`Optional +##### \`ScalingConfig\`Optional \`\`\`csharp public object ScalingConfig { get; } @@ -7488,7 +7532,7 @@ public object ScalingConfig { get; } --- -##### \`Taints\`Optional +##### \`Taints\`Optional \`\`\`csharp public object Taints { get; } @@ -7502,13 +7546,13 @@ public object Taints { get; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -7516,31 +7560,35 @@ public string Version { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnnodegrouppropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Implements:* Amazon.CDK.aws_eks.ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -7550,251 +7598,251 @@ new Cluster(Construct Scope, string Id, ClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksclusterparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`Id\`](#amazoncdkawseksclusterparameterid)* | \`string\` | the id of the Construct to create. | -| [\`Props\`](#amazoncdkawseksclusterparameterprops)* | [\`Amazon.CDK.aws_eks.ClusterProps\`](#Amazon.CDK.aws_eks.ClusterProps) | properties in the IClusterProps interface. | +| Scope | Constructs.Construct | a Construct, most likely a cdk.Stack created. | +| Id | string | the id of the Construct to create. | +| Props | Amazon.CDK.aws_eks.ClusterProps | properties in the IClusterProps interface. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id of the Construct to create. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ClusterProps\`](#Amazon.CDK.aws_eks.ClusterProps) +- *Type:* Amazon.CDK.aws_eks.ClusterProps properties in the IClusterProps interface. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddAutoScalingGroupCapacity\`](#amazoncdkawseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`AddCdk8sChart\`](#amazoncdkawseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`AddFargateProfile\`](#amazoncdkawseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`AddHelmChart\`](#amazoncdkawseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`AddManifest\`](#amazoncdkawseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`AddNodegroupCapacity\`](#amazoncdkawseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`AddServiceAccount\`](#amazoncdkawseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`ConnectAutoScalingGroupCapacity\`](#amazoncdkawseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`GetServiceLoadBalancerAddress\`](#amazoncdkawseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| AddAutoScalingGroupCapacity | Add nodes to this EKS cluster. | +| AddCdk8sChart | Defines a CDK8s chart in this cluster. | +| AddFargateProfile | Adds a Fargate profile to this cluster. | +| AddHelmChart | Defines a Helm chart in this cluster. | +| AddManifest | Defines a Kubernetes resource in this cluster. | +| AddNodegroupCapacity | Add managed nodegroup to this Amazon EKS cluster. | +| AddServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | +| ConnectAutoScalingGroupCapacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| GetServiceLoadBalancerAddress | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`AddAutoScalingGroupCapacity\` +##### \`AddAutoScalingGroupCapacity\` \`\`\`csharp private AddAutoScalingGroupCapacity(string Id, AutoScalingGroupCapacityOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions\`](#Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions) +- *Type:* Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions --- -##### \`AddCdk8sChart\` +##### \`AddCdk8sChart\` \`\`\`csharp private AddCdk8sChart(string Id, Construct Chart) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Chart\`Required +###### \`Chart\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the cdk8s chart. --- -##### \`AddFargateProfile\` +##### \`AddFargateProfile\` \`\`\`csharp private AddFargateProfile(string Id, FargateProfileOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id of this profile. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) +- *Type:* Amazon.CDK.aws_eks.FargateProfileOptions profile options. --- -##### \`AddHelmChart\` +##### \`AddHelmChart\` \`\`\`csharp private AddHelmChart(string Id, HelmChartOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartOptions\`](#Amazon.CDK.aws_eks.HelmChartOptions) +- *Type:* Amazon.CDK.aws_eks.HelmChartOptions options of this chart. --- -##### \`AddManifest\` +##### \`AddManifest\` \`\`\`csharp private AddManifest(string Id, System.Collections.Generic.IDictionary Manifest) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`Manifest\`Required +###### \`Manifest\`Required -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary a list of Kubernetes resource specifications. --- -##### \`AddNodegroupCapacity\` +##### \`AddNodegroupCapacity\` \`\`\`csharp private AddNodegroupCapacity(string Id, NodegroupOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The ID of the nodegroup. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupOptions\`](#Amazon.CDK.aws_eks.NodegroupOptions) +- *Type:* Amazon.CDK.aws_eks.NodegroupOptions options for creating a new nodegroup. --- -##### \`AddServiceAccount\` +##### \`AddServiceAccount\` \`\`\`csharp private AddServiceAccount(string Id, ServiceAccountOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountOptions\`](#Amazon.CDK.aws_eks.ServiceAccountOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountOptions --- -##### \`ConnectAutoScalingGroupCapacity\` +##### \`ConnectAutoScalingGroupCapacity\` \`\`\`csharp private ConnectAutoScalingGroupCapacity(AutoScalingGroup AutoScalingGroup, AutoScalingGroupOptions Options) \`\`\` -###### \`AutoScalingGroup\`Required +###### \`AutoScalingGroup\`Required -- *Type:* [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) +- *Type:* Amazon.CDK.aws_autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AutoScalingGroupOptions\`](#Amazon.CDK.aws_eks.AutoScalingGroupOptions) +- *Type:* Amazon.CDK.aws_eks.AutoScalingGroupOptions options for adding auto scaling groups, like customizing the bootstrap script. --- -##### \`GetServiceLoadBalancerAddress\` +##### \`GetServiceLoadBalancerAddress\` \`\`\`csharp private GetServiceLoadBalancerAddress(string ServiceName, ServiceLoadBalancerAddressOptions Options = null) \`\`\` -###### \`ServiceName\`Required +###### \`ServiceName\`Required -- *Type:* \`string\` +- *Type:* string The name of the service. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions\`](#Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions Additional operation options. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`FromClusterAttributes\`](#amazoncdkawseksclusterfromclusterattributes) | Import an existing cluster. | +| FromClusterAttributes | Import an existing cluster. | --- -##### \`FromClusterAttributes\` +##### \`FromClusterAttributes\` \`\`\`csharp using Amazon.CDK; @@ -7802,68 +7850,68 @@ using Amazon.CDK; Cluster.FromClusterAttributes(Construct Scope, string Id, ClusterAttributes Attrs); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the construct scope, in most cases 'this'. --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id or name to import as. --- -###### \`Attrs\`Required +###### \`Attrs\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ClusterAttributes\`](#Amazon.CDK.aws_eks.ClusterAttributes) +- *Type:* Amazon.CDK.aws_eks.ClusterAttributes the cluster properties to use for importing information. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AdminRole\`](#amazoncdkawseksclusterpropertyadminrole)* | [\`Amazon.CDK.aws_iam.Role\`](#Amazon.CDK.aws_iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`AwsAuth\`](#amazoncdkawseksclusterpropertyawsauth)* | [\`Amazon.CDK.aws_eks.AwsAuth\`](#Amazon.CDK.aws_eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`ClusterArn\`](#amazoncdkawseksclusterpropertyclusterarn)* | \`string\` | The AWS generated ARN for the Cluster resource. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksclusterpropertyclusterendpoint)* | \`string\` | The endpoint URL for the Cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusterpropertyclustername)* | \`string\` | The Name of the created EKS Cluster. | -| [\`ClusterOpenIdConnectIssuer\`](#amazoncdkawseksclusterpropertyclusteropenidconnectissuer)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`ClusterOpenIdConnectIssuerUrl\`](#amazoncdkawseksclusterpropertyclusteropenidconnectissuerurl)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`ClusterSecurityGroup\`](#amazoncdkawseksclusterpropertyclustersecuritygroup)* | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`Connections\`](#amazoncdkawseksclusterpropertyconnections)* | [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksclusterpropertyopenidconnectprovider)* | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`Prune\`](#amazoncdkawseksclusterpropertyprune)* | \`bool\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`Role\`](#amazoncdkawseksclusterpropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`Vpc\`](#amazoncdkawseksclusterpropertyvpc)* | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`DefaultCapacity\`](#amazoncdkawseksclusterpropertydefaultcapacity) | [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`DefaultNodegroup\`](#amazoncdkawseksclusterpropertydefaultnodegroup) | [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterpropertykubectlenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterpropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterpropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`KubectlPrivateSubnets\`](#amazoncdkawseksclusterpropertykubectlprivatesubnets) | [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRole\`](#amazoncdkawseksclusterpropertykubectlrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`KubectlSecurityGroup\`](#amazoncdkawseksclusterpropertykubectlsecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| AdminRole | Amazon.CDK.aws_iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| AwsAuth | Amazon.CDK.aws_eks.AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| ClusterArn | string | The AWS generated ARN for the Cluster resource. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The endpoint URL for the Cluster. | +| ClusterName | string | The Name of the created EKS Cluster. | +| ClusterOpenIdConnectIssuer | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| ClusterOpenIdConnectIssuerUrl | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| ClusterSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| ClusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| Connections | Amazon.CDK.aws_ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| Prune | bool | Determines if Kubernetes resources can be pruned automatically. | +| Role | Amazon.CDK.aws_iam.IRole | IAM role assumed by the EKS Control Plane. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| DefaultCapacity | Amazon.CDK.aws_autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| DefaultNodegroup | Amazon.CDK.aws_eks.Nodegroup | The node group that hosts the default capacity for this cluster. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| KubectlPrivateSubnets | Amazon.CDK.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRole | Amazon.CDK.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| KubectlSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`AdminRole\`Required +##### \`AdminRole\`Required \`\`\`csharp public Role AdminRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.Role\`](#Amazon.CDK.aws_iam.Role) +- *Type:* Amazon.CDK.aws_iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -7871,61 +7919,61 @@ This role also has \`systems:master\` permissions. --- -##### \`AwsAuth\`Required +##### \`AwsAuth\`Required \`\`\`csharp public AwsAuth AwsAuth { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuth\`](#Amazon.CDK.aws_eks.AwsAuth) +- *Type:* Amazon.CDK.aws_eks.AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`ClusterArn\`Required +##### \`ClusterArn\`Required \`\`\`csharp public string ClusterArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The AWS generated ARN for the Cluster resource. --- -##### \`ClusterCertificateAuthorityData\`Required +##### \`ClusterCertificateAuthorityData\`Required \`\`\`csharp public string ClusterCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Required +##### \`ClusterEncryptionConfigKeyArn\`Required \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Required +##### \`ClusterEndpoint\`Required \`\`\`csharp public string ClusterEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The endpoint URL for the Cluster. @@ -7933,25 +7981,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Name of the created EKS Cluster. --- -##### \`ClusterOpenIdConnectIssuer\`Required +##### \`ClusterOpenIdConnectIssuer\`Required \`\`\`csharp public string ClusterOpenIdConnectIssuer { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -7959,13 +8007,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`ClusterOpenIdConnectIssuerUrl\`Required +##### \`ClusterOpenIdConnectIssuerUrl\`Required \`\`\`csharp public string ClusterOpenIdConnectIssuerUrl { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -7973,49 +8021,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`ClusterSecurityGroup\`Required +##### \`ClusterSecurityGroup\`Required \`\`\`csharp public ISecurityGroup ClusterSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`ClusterSecurityGroupId\`Required +##### \`ClusterSecurityGroupId\`Required \`\`\`csharp public string ClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`Connections\`Required +##### \`Connections\`Required \`\`\`csharp public Connections Connections { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) +- *Type:* Amazon.CDK.aws_ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`OpenIdConnectProvider\`Required +##### \`OpenIdConnectProvider\`Required \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -8023,49 +8071,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`Prune\`Required +##### \`Prune\`Required \`\`\`csharp public bool Prune { get; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool Determines if Kubernetes resources can be pruned automatically. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`Vpc\`Required +##### \`Vpc\`Required \`\`\`csharp public IVpc Vpc { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`DefaultCapacity\`Optional +##### \`DefaultCapacity\`Optional \`\`\`csharp public AutoScalingGroup DefaultCapacity { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) +- *Type:* Amazon.CDK.aws_autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -8073,13 +8121,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`DefaultNodegroup\`Optional +##### \`DefaultNodegroup\`Optional \`\`\`csharp public Nodegroup DefaultNodegroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup) +- *Type:* Amazon.CDK.aws_eks.Nodegroup The node group that hosts the default capacity for this cluster. @@ -8087,25 +8135,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -8113,38 +8161,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`KubectlPrivateSubnets\`Optional +##### \`KubectlPrivateSubnets\`Optional \`\`\`csharp public ISubnet[] KubectlPrivateSubnets { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] +- *Type:* Amazon.CDK.aws_ec2.ISubnet[] - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`KubectlRole\`Optional +##### \`KubectlRole\`Optional \`\`\`csharp public IRole KubectlRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -8152,13 +8200,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`KubectlSecurityGroup\`Optional +##### \`KubectlSecurityGroup\`Optional \`\`\`csharp public ISecurityGroup KubectlSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -8166,13 +8214,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8182,27 +8230,27 @@ new FargateCluster(Construct Scope, string Id, FargateClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksfargateclusterparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksfargateclusterparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksfargateclusterparameterprops)* | [\`Amazon.CDK.aws_eks.FargateClusterProps\`](#Amazon.CDK.aws_eks.FargateClusterProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.FargateClusterProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateClusterProps\`](#Amazon.CDK.aws_eks.FargateClusterProps) +- *Type:* Amazon.CDK.aws_eks.FargateClusterProps --- @@ -8210,15 +8258,15 @@ new FargateCluster(Construct Scope, string Id, FargateClusterProps Props); -### FargateProfile +### FargateProfile -- *Implements:* [\`Amazon.CDK.ITaggable\`](#Amazon.CDK.ITaggable) +- *Implements:* Amazon.CDK.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8228,74 +8276,74 @@ new FargateProfile(Construct Scope, string Id, FargateProfileProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksfargateprofileparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksfargateprofileparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksfargateprofileparameterprops)* | [\`Amazon.CDK.aws_eks.FargateProfileProps\`](#Amazon.CDK.aws_eks.FargateProfileProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.FargateProfileProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileProps\`](#Amazon.CDK.aws_eks.FargateProfileProps) +- *Type:* Amazon.CDK.aws_eks.FargateProfileProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`FargateProfileArn\`](#amazoncdkawseksfargateprofilepropertyfargateprofilearn)* | \`string\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofilepropertyfargateprofilename)* | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofilepropertypodexecutionrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`Tags\`](#amazoncdkawseksfargateprofilepropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | Resource tags. | +| FargateProfileArn | string | The full Amazon Resource Name (ARN) of the Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| Tags | Amazon.CDK.TagManager | Resource tags. | --- -##### \`FargateProfileArn\`Required +##### \`FargateProfileArn\`Required \`\`\`csharp public string FargateProfileArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`FargateProfileName\`Required +##### \`FargateProfileName\`Required \`\`\`csharp public string FargateProfileName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the Fargate profile. --- -##### \`PodExecutionRole\`Required +##### \`PodExecutionRole\`Required \`\`\`csharp public IRole PodExecutionRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -8303,26 +8351,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8332,56 +8380,60 @@ new HelmChart(Construct Scope, string Id, HelmChartProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekshelmchartparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekshelmchartparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekshelmchartparameterprops)* | [\`Amazon.CDK.aws_eks.HelmChartProps\`](#Amazon.CDK.aws_eks.HelmChartProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.HelmChartProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartProps\`](#Amazon.CDK.aws_eks.HelmChartProps) +- *Type:* Amazon.CDK.aws_eks.HelmChartProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekshelmchartpropertyresourcetype)* | \`string\` | The CloudFormation resource type. | +| ResourceType | string | The CloudFormation resource type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required + +\`\`\`csharp +public string ResourceType { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8391,56 +8443,60 @@ new KubernetesManifest(Construct Scope, string Id, KubernetesManifestProps Props | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetesmanifestparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetesmanifestparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetesmanifestparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesManifestProps\`](#Amazon.CDK.aws_eks.KubernetesManifestProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesManifestProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesManifestProps\`](#Amazon.CDK.aws_eks.KubernetesManifestProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesManifestProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekskubernetesmanifestpropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| ResourceType | string | The CloudFormation reosurce type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required -- *Type:* \`string\` +\`\`\`csharp +public string ResourceType { get; } +\`\`\` + +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8450,75 +8506,79 @@ new KubernetesObjectValue(Construct Scope, string Id, KubernetesObjectValueProps | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetesobjectvalueparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetesobjectvalueparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetesobjectvalueparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesObjectValueProps\`](#Amazon.CDK.aws_eks.KubernetesObjectValueProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesObjectValueProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesObjectValueProps\`](#Amazon.CDK.aws_eks.KubernetesObjectValueProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesObjectValueProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Value\`](#amazoncdkawsekskubernetesobjectvaluepropertyvalue)* | \`string\` | The value as a string token. | +| Value | string | The value as a string token. | --- -##### \`Value\`Required +##### \`Value\`Required \`\`\`csharp public string Value { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekskubernetesobjectvaluepropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| ResourceType | string | The CloudFormation reosurce type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required -- *Type:* \`string\` +\`\`\`csharp +public string ResourceType { get; } +\`\`\` + +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8528,27 +8588,27 @@ new KubernetesPatch(Construct Scope, string Id, KubernetesPatchProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetespatchparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetespatchparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetespatchparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesPatchProps\`](#Amazon.CDK.aws_eks.KubernetesPatchProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesPatchProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesPatchProps\`](#Amazon.CDK.aws_eks.KubernetesPatchProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesPatchProps --- @@ -8556,13 +8616,13 @@ new KubernetesPatch(Construct Scope, string Id, KubernetesPatchProps Props); -### Nodegroup +### Nodegroup -- *Implements:* [\`Amazon.CDK.aws_eks.INodegroup\`](#Amazon.CDK.aws_eks.INodegroup) +- *Implements:* Amazon.CDK.aws_eks.INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8572,40 +8632,40 @@ new Nodegroup(Construct Scope, string Id, NodegroupProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksnodegroupparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksnodegroupparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksnodegroupparameterprops)* | [\`Amazon.CDK.aws_eks.NodegroupProps\`](#Amazon.CDK.aws_eks.NodegroupProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.NodegroupProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupProps\`](#Amazon.CDK.aws_eks.NodegroupProps) +- *Type:* Amazon.CDK.aws_eks.NodegroupProps --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`FromNodegroupName\`](#amazoncdkawseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| FromNodegroupName | Import the Nodegroup from attributes. | --- -##### \`FromNodegroupName\` +##### \`FromNodegroupName\` \`\`\`csharp using Amazon.CDK; @@ -8613,93 +8673,93 @@ using Amazon.CDK; Nodegroup.FromNodegroupName(Construct Scope, string Id, string NodegroupName); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`NodegroupName\`Required +###### \`NodegroupName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawseksnodegrouppropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | the Amazon EKS cluster resource. | -| [\`NodegroupArn\`](#amazoncdkawseksnodegrouppropertynodegrouparn)* | \`string\` | ARN of the nodegroup. | -| [\`NodegroupName\`](#amazoncdkawseksnodegrouppropertynodegroupname)* | \`string\` | Nodegroup name. | -| [\`Role\`](#amazoncdkawseksnodegrouppropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | IAM role of the instance profile for the nodegroup. | +| Cluster | Amazon.CDK.aws_eks.ICluster | the Amazon EKS cluster resource. | +| NodegroupArn | string | ARN of the nodegroup. | +| NodegroupName | string | Nodegroup name. | +| Role | Amazon.CDK.aws_iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster the Amazon EKS cluster resource. --- -##### \`NodegroupArn\`Required +##### \`NodegroupArn\`Required \`\`\`csharp public string NodegroupArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string ARN of the nodegroup. --- -##### \`NodegroupName\`Required +##### \`NodegroupName\`Required \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Nodegroup name. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8709,31 +8769,31 @@ new OpenIdConnectProvider(Construct Scope, string Id, OpenIdConnectProviderProps | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksopenidconnectproviderparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | The definition scope. | -| [\`Id\`](#amazoncdkawseksopenidconnectproviderparameterid)* | \`string\` | Construct ID. | -| [\`Props\`](#amazoncdkawseksopenidconnectproviderparameterprops)* | [\`Amazon.CDK.aws_eks.OpenIdConnectProviderProps\`](#Amazon.CDK.aws_eks.OpenIdConnectProviderProps) | Initialization properties. | +| Scope | Constructs.Construct | The definition scope. | +| Id | string | Construct ID. | +| Props | Amazon.CDK.aws_eks.OpenIdConnectProviderProps | Initialization properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct The definition scope. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string Construct ID. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.OpenIdConnectProviderProps\`](#Amazon.CDK.aws_eks.OpenIdConnectProviderProps) +- *Type:* Amazon.CDK.aws_eks.OpenIdConnectProviderProps Initialization properties. @@ -8743,13 +8803,13 @@ Initialization properties. -### ServiceAccount +### ServiceAccount -- *Implements:* [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) +- *Implements:* Amazon.CDK.aws_iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -8759,144 +8819,144 @@ new ServiceAccount(Construct Scope, string Id, ServiceAccountProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksserviceaccountparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksserviceaccountparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksserviceaccountparameterprops)* | [\`Amazon.CDK.aws_eks.ServiceAccountProps\`](#Amazon.CDK.aws_eks.ServiceAccountProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.ServiceAccountProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountProps\`](#Amazon.CDK.aws_eks.ServiceAccountProps) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToPrincipalPolicy\`](#amazoncdkawseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| AddToPrincipalPolicy | Add to the policy of this principal. | --- -##### \`AddToPrincipalPolicy\` +##### \`AddToPrincipalPolicy\` \`\`\`csharp private AddToPrincipalPolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.aws_iam.PolicyStatement\`](#Amazon.CDK.aws_iam.PolicyStatement) +- *Type:* Amazon.CDK.aws_iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AssumeRoleAction\`](#amazoncdkawseksserviceaccountpropertyassumeroleaction)* | \`string\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`GrantPrincipal\`](#amazoncdkawseksserviceaccountpropertygrantprincipal)* | [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) | The principal to grant permissions to. | -| [\`PolicyFragment\`](#amazoncdkawseksserviceaccountpropertypolicyfragment)* | [\`Amazon.CDK.aws_iam.PrincipalPolicyFragment\`](#Amazon.CDK.aws_iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`Role\`](#amazoncdkawseksserviceaccountpropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The role which is linked to the service account. | -| [\`ServiceAccountName\`](#amazoncdkawseksserviceaccountpropertyserviceaccountname)* | \`string\` | The name of the service account. | -| [\`ServiceAccountNamespace\`](#amazoncdkawseksserviceaccountpropertyserviceaccountnamespace)* | \`string\` | The namespace where the service account is located in. | +| AssumeRoleAction | string | When this Principal is used in an AssumeRole policy, the action to use. | +| GrantPrincipal | Amazon.CDK.aws_iam.IPrincipal | The principal to grant permissions to. | +| PolicyFragment | Amazon.CDK.aws_iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| Role | Amazon.CDK.aws_iam.IRole | The role which is linked to the service account. | +| ServiceAccountName | string | The name of the service account. | +| ServiceAccountNamespace | string | The namespace where the service account is located in. | --- -##### \`AssumeRoleAction\`Required +##### \`AssumeRoleAction\`Required \`\`\`csharp public string AssumeRoleAction { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`GrantPrincipal\`Required +##### \`GrantPrincipal\`Required \`\`\`csharp public IPrincipal GrantPrincipal { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) +- *Type:* Amazon.CDK.aws_iam.IPrincipal The principal to grant permissions to. --- -##### \`PolicyFragment\`Required +##### \`PolicyFragment\`Required \`\`\`csharp public PrincipalPolicyFragment PolicyFragment { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.PrincipalPolicyFragment\`](#Amazon.CDK.aws_iam.PrincipalPolicyFragment) +- *Type:* Amazon.CDK.aws_iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The role which is linked to the service account. --- -##### \`ServiceAccountName\`Required +##### \`ServiceAccountName\`Required \`\`\`csharp public string ServiceAccountName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the service account. --- -##### \`ServiceAccountNamespace\`Required +##### \`ServiceAccountNamespace\`Required \`\`\`csharp public string ServiceAccountNamespace { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -8931,72 +8991,72 @@ new AutoScalingGroupCapacityOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AllowAllOutbound\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`bool\` | Whether the instances can initiate connections to anywhere by default. | -| [\`AssociatePublicIpAddress\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`bool\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`AutoScalingGroupName\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`string\` | The name of the Auto Scaling group. | -| [\`BlockDevices\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyblockdevices) | [\`Amazon.CDK.aws_autoscaling.BlockDevice\`](#Amazon.CDK.aws_autoscaling.BlockDevice)[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`Cooldown\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertycooldown) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`DesiredCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`double\` | Initial amount of instances in the fleet. | -| [\`GroupMetrics\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertygroupmetrics) | [\`Amazon.CDK.aws_autoscaling.GroupMetrics\`](#Amazon.CDK.aws_autoscaling.GroupMetrics)[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`HealthCheck\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`Amazon.CDK.aws_autoscaling.HealthCheck\`](#Amazon.CDK.aws_autoscaling.HealthCheck) | Configuration for health checks. | -| [\`IgnoreUnmodifiedSizeProperties\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`bool\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`InstanceMonitoring\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`Amazon.CDK.aws_autoscaling.Monitoring\`](#Amazon.CDK.aws_autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`KeyName\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertykeyname) | \`string\` | Name of SSH keypair to grant access to instances. | -| [\`MaxCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`double\` | Maximum number of instances in the fleet. | -| [\`MaxInstanceLifetime\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The maximum amount of time that an instance can be in service. | -| [\`MinCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymincapacity) | \`double\` | Minimum number of instances in the fleet. | -| [\`NewInstancesProtectedFromScaleIn\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`bool\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`Notifications\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertynotifications) | [\`Amazon.CDK.aws_autoscaling.NotificationConfiguration\`](#Amazon.CDK.aws_autoscaling.NotificationConfiguration)[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`Signals\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertysignals) | [\`Amazon.CDK.aws_autoscaling.Signals\`](#Amazon.CDK.aws_autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`SpotPrice\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyspotprice) | \`string\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`UpdatePolicy\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`Amazon.CDK.aws_autoscaling.UpdatePolicy\`](#Amazon.CDK.aws_autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`VpcSubnets\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`InstanceType\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | Instance type of the instances to start. | -| [\`BootstrapEnabled\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`BootstrapOptions\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`MachineImageType\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) | Machine image type. | -| [\`MapRole\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`SpotInterruptHandler\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| AllowAllOutbound | bool | Whether the instances can initiate connections to anywhere by default. | +| AssociatePublicIpAddress | bool | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| AutoScalingGroupName | string | The name of the Auto Scaling group. | +| BlockDevices | Amazon.CDK.aws_autoscaling.BlockDevice[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| Cooldown | Amazon.CDK.Duration | Default scaling cooldown for this AutoScalingGroup. | +| DesiredCapacity | double | Initial amount of instances in the fleet. | +| GroupMetrics | Amazon.CDK.aws_autoscaling.GroupMetrics[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| HealthCheck | Amazon.CDK.aws_autoscaling.HealthCheck | Configuration for health checks. | +| IgnoreUnmodifiedSizeProperties | bool | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| InstanceMonitoring | Amazon.CDK.aws_autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| KeyName | string | Name of SSH keypair to grant access to instances. | +| MaxCapacity | double | Maximum number of instances in the fleet. | +| MaxInstanceLifetime | Amazon.CDK.Duration | The maximum amount of time that an instance can be in service. | +| MinCapacity | double | Minimum number of instances in the fleet. | +| NewInstancesProtectedFromScaleIn | bool | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| Notifications | Amazon.CDK.aws_autoscaling.NotificationConfiguration[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| Signals | Amazon.CDK.aws_autoscaling.Signals | Configure waiting for signals during deployment. | +| SpotPrice | string | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| UpdatePolicy | Amazon.CDK.aws_autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection | Where to place instances within the VPC. | +| InstanceType | Amazon.CDK.aws_ec2.InstanceType | Instance type of the instances to start. | +| BootstrapEnabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| BootstrapOptions | Amazon.CDK.aws_eks.BootstrapOptions | EKS node bootstrapping options. | +| MachineImageType | Amazon.CDK.aws_eks.MachineImageType | Machine image type. | +| MapRole | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| SpotInterruptHandler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`AllowAllOutbound\`Optional +##### \`AllowAllOutbound\`Optional \`\`\`csharp public bool AllowAllOutbound { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`AssociatePublicIpAddress\`Optional +##### \`AssociatePublicIpAddress\`Optional \`\`\`csharp public bool AssociatePublicIpAddress { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`AutoScalingGroupName\`Optional +##### \`AutoScalingGroupName\`Optional \`\`\`csharp public string AutoScalingGroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -9005,60 +9065,60 @@ This name must be unique per Region per account. --- -##### \`BlockDevices\`Optional +##### \`BlockDevices\`Optional \`\`\`csharp public BlockDevice[] BlockDevices { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.BlockDevice\`](#Amazon.CDK.aws_autoscaling.BlockDevice)[] +- *Type:* Amazon.CDK.aws_autoscaling.BlockDevice[] - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`Cooldown\`Optional +##### \`Cooldown\`Optional \`\`\`csharp public Duration Cooldown { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`DesiredCapacity\`Optional +##### \`DesiredCapacity\`Optional \`\`\`csharp public double DesiredCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`GroupMetrics\`Optional +##### \`GroupMetrics\`Optional \`\`\`csharp public GroupMetrics[] GroupMetrics { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.GroupMetrics\`](#Amazon.CDK.aws_autoscaling.GroupMetrics)[] +- *Type:* Amazon.CDK.aws_autoscaling.GroupMetrics[] - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -9067,26 +9127,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`HealthCheck\`Optional +##### \`HealthCheck\`Optional \`\`\`csharp public HealthCheck HealthCheck { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.HealthCheck\`](#Amazon.CDK.aws_autoscaling.HealthCheck) +- *Type:* Amazon.CDK.aws_autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`IgnoreUnmodifiedSizeProperties\`Optional +##### \`IgnoreUnmodifiedSizeProperties\`Optional \`\`\`csharp public bool IgnoreUnmodifiedSizeProperties { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -9095,86 +9155,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`InstanceMonitoring\`Optional +##### \`InstanceMonitoring\`Optional \`\`\`csharp public Monitoring InstanceMonitoring { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.Monitoring\`](#Amazon.CDK.aws_autoscaling.Monitoring) +- *Type:* Amazon.CDK.aws_autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`KeyName\`Optional +##### \`KeyName\`Optional \`\`\`csharp public string KeyName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`MaxCapacity\`Optional +##### \`MaxCapacity\`Optional \`\`\`csharp public double MaxCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`MaxInstanceLifetime\`Optional +##### \`MaxInstanceLifetime\`Optional \`\`\`csharp public Duration MaxInstanceLifetime { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`MinCapacity\`Optional +##### \`MinCapacity\`Optional \`\`\`csharp public double MinCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`NewInstancesProtectedFromScaleIn\`Optional +##### \`NewInstancesProtectedFromScaleIn\`Optional \`\`\`csharp public bool NewInstancesProtectedFromScaleIn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -9183,28 +9243,28 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`Notifications\`Optional +##### \`Notifications\`Optional \`\`\`csharp public NotificationConfiguration[] Notifications { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.NotificationConfiguration\`](#Amazon.CDK.aws_autoscaling.NotificationConfiguration)[] +- *Type:* Amazon.CDK.aws_autoscaling.NotificationConfiguration[] - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### \`Signals\`Optional +##### \`Signals\`Optional \`\`\`csharp public Signals Signals { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.Signals\`](#Amazon.CDK.aws_autoscaling.Signals) +- *Type:* Amazon.CDK.aws_autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -9213,13 +9273,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`SpotPrice\`Optional +##### \`SpotPrice\`Optional \`\`\`csharp public string SpotPrice { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -9228,13 +9288,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`UpdatePolicy\`Optional +##### \`UpdatePolicy\`Optional \`\`\`csharp public UpdatePolicy UpdatePolicy { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.UpdatePolicy\`](#Amazon.CDK.aws_autoscaling.UpdatePolicy) +- *Type:* Amazon.CDK.aws_autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -9243,38 +9303,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`InstanceType\`Required +##### \`InstanceType\`Required \`\`\`csharp public InstanceType InstanceType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType Instance type of the instances to start. --- -##### \`BootstrapEnabled\`Optional +##### \`BootstrapEnabled\`Optional \`\`\`csharp public bool BootstrapEnabled { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -9283,39 +9343,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`BootstrapOptions\`Optional +##### \`BootstrapOptions\`Optional \`\`\`csharp public BootstrapOptions BootstrapOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) +- *Type:* Amazon.CDK.aws_eks.BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`MachineImageType\`Optional +##### \`MachineImageType\`Optional \`\`\`csharp public MachineImageType MachineImageType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) +- *Type:* Amazon.CDK.aws_eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`MapRole\`Optional +##### \`MapRole\`Optional \`\`\`csharp public bool MapRole { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -9324,13 +9384,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`SpotInterruptHandler\`Optional +##### \`SpotInterruptHandler\`Optional \`\`\`csharp public bool SpotInterruptHandler { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -9339,11 +9399,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9357,25 +9417,25 @@ new AutoScalingGroupOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`BootstrapEnabled\`](#amazoncdkawseksautoscalinggroupoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`BootstrapOptions\`](#amazoncdkawseksautoscalinggroupoptionspropertybootstrapoptions) | [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`MachineImageType\`](#amazoncdkawseksautoscalinggroupoptionspropertymachineimagetype) | [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`MapRole\`](#amazoncdkawseksautoscalinggroupoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`SpotInterruptHandler\`](#amazoncdkawseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| BootstrapEnabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| BootstrapOptions | Amazon.CDK.aws_eks.BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| MachineImageType | Amazon.CDK.aws_eks.MachineImageType | Allow options to specify different machine image type. | +| MapRole | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| SpotInterruptHandler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`BootstrapEnabled\`Optional +##### \`BootstrapEnabled\`Optional \`\`\`csharp public bool BootstrapEnabled { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -9384,39 +9444,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`BootstrapOptions\`Optional +##### \`BootstrapOptions\`Optional \`\`\`csharp public BootstrapOptions BootstrapOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) +- *Type:* Amazon.CDK.aws_eks.BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`MachineImageType\`Optional +##### \`MachineImageType\`Optional \`\`\`csharp public MachineImageType MachineImageType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) +- *Type:* Amazon.CDK.aws_eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`MapRole\`Optional +##### \`MapRole\`Optional \`\`\`csharp public bool MapRole { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -9425,13 +9485,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`SpotInterruptHandler\`Optional +##### \`SpotInterruptHandler\`Optional \`\`\`csharp public bool SpotInterruptHandler { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -9440,11 +9500,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9455,47 +9515,47 @@ new AwsAuthMapping { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Groups\`](#amazoncdkawseksawsauthmappingpropertygroups)* | \`string\`[] | A list of groups within Kubernetes to which the role is mapped. | -| [\`Username\`](#amazoncdkawseksawsauthmappingpropertyusername) | \`string\` | The user name within Kubernetes to map to the IAM role. | +| Groups | string[] | A list of groups within Kubernetes to which the role is mapped. | +| Username | string | The user name within Kubernetes to map to the IAM role. | --- -##### \`Groups\`Required +##### \`Groups\`Required \`\`\`csharp public string[] Groups { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`Username\`Optional +##### \`Username\`Optional \`\`\`csharp public string Username { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9505,21 +9565,21 @@ new AwsAuthProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawseksawsauthpropspropertycluster)* | [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) | The EKS cluster to apply this configuration to. | +| Cluster | Amazon.CDK.aws_eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public Cluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) +- *Type:* Amazon.CDK.aws_eks.Cluster The EKS cluster to apply this configuration to. @@ -9527,11 +9587,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9547,94 +9607,94 @@ new BootstrapOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AdditionalArgs\`](#amazoncdkawseksbootstrapoptionspropertyadditionalargs) | \`string\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`AwsApiRetryAttempts\`](#amazoncdkawseksbootstrapoptionspropertyawsapiretryattempts) | \`double\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`DnsClusterIp\`](#amazoncdkawseksbootstrapoptionspropertydnsclusterip) | \`string\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`DockerConfigJson\`](#amazoncdkawseksbootstrapoptionspropertydockerconfigjson) | \`string\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`EnableDockerBridge\`](#amazoncdkawseksbootstrapoptionspropertyenabledockerbridge) | \`bool\` | Restores the docker default bridge network. | -| [\`KubeletExtraArgs\`](#amazoncdkawseksbootstrapoptionspropertykubeletextraargs) | \`string\` | Extra arguments to add to the kubelet. | -| [\`UseMaxPods\`](#amazoncdkawseksbootstrapoptionspropertyusemaxpods) | \`bool\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| AdditionalArgs | string | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| AwsApiRetryAttempts | double | Number of retry attempts for AWS API call (DescribeCluster). | +| DnsClusterIp | string | Overrides the IP address to use for DNS queries within the cluster. | +| DockerConfigJson | string | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| EnableDockerBridge | bool | Restores the docker default bridge network. | +| KubeletExtraArgs | string | Extra arguments to add to the kubelet. | +| UseMaxPods | bool | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`AdditionalArgs\`Optional +##### \`AdditionalArgs\`Optional \`\`\`csharp public string AdditionalArgs { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`AwsApiRetryAttempts\`Optional +##### \`AwsApiRetryAttempts\`Optional \`\`\`csharp public double AwsApiRetryAttempts { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`DnsClusterIp\`Optional +##### \`DnsClusterIp\`Optional \`\`\`csharp public string DnsClusterIp { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`DockerConfigJson\`Optional +##### \`DockerConfigJson\`Optional \`\`\`csharp public string DockerConfigJson { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`EnableDockerBridge\`Optional +##### \`EnableDockerBridge\`Optional \`\`\`csharp public bool EnableDockerBridge { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Restores the docker default bridge network. --- -##### \`KubeletExtraArgs\`Optional +##### \`KubeletExtraArgs\`Optional \`\`\`csharp public string KubeletExtraArgs { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Extra arguments to add to the kubelet. @@ -9643,26 +9703,26 @@ Useful for adding labels or taints. --- -##### \`UseMaxPods\`Optional +##### \`UseMaxPods\`Optional \`\`\`csharp public bool UseMaxPods { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9677,26 +9737,26 @@ new CfnAddonProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AddonName\`](#amazoncdkawsekscfnaddonpropspropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnaddonpropspropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`AddonVersion\`](#amazoncdkawsekscfnaddonpropspropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`ResolveConflicts\`](#amazoncdkawsekscfnaddonpropspropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`ServiceAccountRoleArn\`](#amazoncdkawsekscfnaddonpropspropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`Tags\`](#amazoncdkawsekscfnaddonpropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::EKS::Addon.Tags\`. | +| AddonName | string | \`AWS::EKS::Addon.AddonName\`. | +| ClusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| AddonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| ResolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| ServiceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::EKS::Addon.Tags\`. | --- -##### \`AddonName\`Required +##### \`AddonName\`Required \`\`\`csharp public string AddonName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -9704,13 +9764,13 @@ public string AddonName { get; set; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -9718,13 +9778,13 @@ public string ClusterName { get; set; } --- -##### \`AddonVersion\`Optional +##### \`AddonVersion\`Optional \`\`\`csharp public string AddonVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -9732,13 +9792,13 @@ public string AddonVersion { get; set; } --- -##### \`ResolveConflicts\`Optional +##### \`ResolveConflicts\`Optional \`\`\`csharp public string ResolveConflicts { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -9746,13 +9806,13 @@ public string ResolveConflicts { get; set; } --- -##### \`ServiceAccountRoleArn\`Optional +##### \`ServiceAccountRoleArn\`Optional \`\`\`csharp public string ServiceAccountRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -9760,13 +9820,13 @@ public string ServiceAccountRoleArn { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::EKS::Addon.Tags\`. @@ -9774,13 +9834,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9795,20 +9855,20 @@ new CfnClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourcesVpcConfig\`](#amazoncdkawsekscfnclusterpropspropertyresourcesvpcconfig)* | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`RoleArn\`](#amazoncdkawsekscfnclusterpropspropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`EncryptionConfig\`](#amazoncdkawsekscfnclusterpropspropertyencryptionconfig) | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`KubernetesNetworkConfig\`](#amazoncdkawsekscfnclusterpropspropertykubernetesnetworkconfig) | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`Name\`](#amazoncdkawsekscfnclusterpropspropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnclusterpropspropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| ResourcesVpcConfig | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| RoleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| EncryptionConfig | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| KubernetesNetworkConfig | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| Name | string | \`AWS::EKS::Cluster.Name\`. | +| Version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`ResourcesVpcConfig\`Required +##### \`ResourcesVpcConfig\`Required \`\`\`csharp public object ResourcesVpcConfig { get; set; } @@ -9822,13 +9882,13 @@ public object ResourcesVpcConfig { get; set; } --- -##### \`RoleArn\`Required +##### \`RoleArn\`Required \`\`\`csharp public string RoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -9836,7 +9896,7 @@ public string RoleArn { get; set; } --- -##### \`EncryptionConfig\`Optional +##### \`EncryptionConfig\`Optional \`\`\`csharp public object EncryptionConfig { get; set; } @@ -9850,7 +9910,7 @@ public object EncryptionConfig { get; set; } --- -##### \`KubernetesNetworkConfig\`Optional +##### \`KubernetesNetworkConfig\`Optional \`\`\`csharp public object KubernetesNetworkConfig { get; set; } @@ -9864,13 +9924,13 @@ public object KubernetesNetworkConfig { get; set; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -9878,13 +9938,13 @@ public string Name { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -9892,13 +9952,13 @@ public string Version { get; set; } --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -9913,26 +9973,26 @@ new CfnFargateProfileProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawsekscfnfargateprofilepropspropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`PodExecutionRoleArn\`](#amazoncdkawsekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`Selectors\`](#amazoncdkawsekscfnfargateprofilepropspropertyselectors)* | object | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`FargateProfileName\`](#amazoncdkawsekscfnfargateprofilepropspropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`Subnets\`](#amazoncdkawsekscfnfargateprofilepropspropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`Tags\`](#amazoncdkawsekscfnfargateprofilepropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::EKS::FargateProfile.Tags\`. | +| ClusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| PodExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| Selectors | object | \`AWS::EKS::FargateProfile.Selectors\`. | +| FargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| Subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -9940,13 +10000,13 @@ public string ClusterName { get; set; } --- -##### \`PodExecutionRoleArn\`Required +##### \`PodExecutionRoleArn\`Required \`\`\`csharp public string PodExecutionRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -9954,7 +10014,7 @@ public string PodExecutionRoleArn { get; set; } --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public object Selectors { get; set; } @@ -9968,13 +10028,13 @@ public object Selectors { get; set; } --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -9982,13 +10042,13 @@ public string FargateProfileName { get; set; } --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public string[] Subnets { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -9996,13 +10056,13 @@ public string[] Subnets { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::EKS::FargateProfile.Tags\`. @@ -10010,13 +10070,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -10042,37 +10102,37 @@ new CfnNodegroupProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawsekscfnnodegrouppropspropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`NodeRole\`](#amazoncdkawsekscfnnodegrouppropspropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`Subnets\`](#amazoncdkawsekscfnnodegrouppropspropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`AmiType\`](#amazoncdkawsekscfnnodegrouppropspropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`CapacityType\`](#amazoncdkawsekscfnnodegrouppropspropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`DiskSize\`](#amazoncdkawsekscfnnodegrouppropspropertydisksize) | \`double\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`ForceUpdateEnabled\`](#amazoncdkawsekscfnnodegrouppropspropertyforceupdateenabled) | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`InstanceTypes\`](#amazoncdkawsekscfnnodegrouppropspropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`Labels\`](#amazoncdkawsekscfnnodegrouppropspropertylabels) | \`object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`LaunchTemplate\`](#amazoncdkawsekscfnnodegrouppropspropertylaunchtemplate) | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`NodegroupName\`](#amazoncdkawsekscfnnodegrouppropspropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`ReleaseVersion\`](#amazoncdkawsekscfnnodegrouppropspropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`RemoteAccess\`](#amazoncdkawsekscfnnodegrouppropspropertyremoteaccess) | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`ScalingConfig\`](#amazoncdkawsekscfnnodegrouppropspropertyscalingconfig) | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`Tags\`](#amazoncdkawsekscfnnodegrouppropspropertytags) | \`object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`Taints\`](#amazoncdkawsekscfnnodegrouppropspropertytaints) | object | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouppropspropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| ClusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| NodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| Subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| AmiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| CapacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| DiskSize | double | \`AWS::EKS::Nodegroup.DiskSize\`. | +| ForceUpdateEnabled | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| InstanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| Labels | object | \`AWS::EKS::Nodegroup.Labels\`. | +| LaunchTemplate | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| NodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| ReleaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| RemoteAccess | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| ScalingConfig | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| Tags | object | \`AWS::EKS::Nodegroup.Tags\`. | +| Taints | object | \`AWS::EKS::Nodegroup.Taints\`. | +| Version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -10080,13 +10140,13 @@ public string ClusterName { get; set; } --- -##### \`NodeRole\`Required +##### \`NodeRole\`Required \`\`\`csharp public string NodeRole { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -10094,13 +10154,13 @@ public string NodeRole { get; set; } --- -##### \`Subnets\`Required +##### \`Subnets\`Required \`\`\`csharp public string[] Subnets { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -10108,13 +10168,13 @@ public string[] Subnets { get; set; } --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public string AmiType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -10122,13 +10182,13 @@ public string AmiType { get; set; } --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public string CapacityType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -10136,13 +10196,13 @@ public string CapacityType { get; set; } --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`AWS::EKS::Nodegroup.DiskSize\`. @@ -10150,7 +10210,7 @@ public double DiskSize { get; set; } --- -##### \`ForceUpdateEnabled\`Optional +##### \`ForceUpdateEnabled\`Optional \`\`\`csharp public object ForceUpdateEnabled { get; set; } @@ -10164,13 +10224,13 @@ public object ForceUpdateEnabled { get; set; } --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public string[] InstanceTypes { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -10178,13 +10238,13 @@ public string[] InstanceTypes { get; set; } --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public object Labels { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Labels\`. @@ -10192,7 +10252,7 @@ public object Labels { get; set; } --- -##### \`LaunchTemplate\`Optional +##### \`LaunchTemplate\`Optional \`\`\`csharp public object LaunchTemplate { get; set; } @@ -10206,13 +10266,13 @@ public object LaunchTemplate { get; set; } --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -10220,13 +10280,13 @@ public string NodegroupName { get; set; } --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -10234,7 +10294,7 @@ public string ReleaseVersion { get; set; } --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public object RemoteAccess { get; set; } @@ -10248,7 +10308,7 @@ public object RemoteAccess { get; set; } --- -##### \`ScalingConfig\`Optional +##### \`ScalingConfig\`Optional \`\`\`csharp public object ScalingConfig { get; set; } @@ -10262,13 +10322,13 @@ public object ScalingConfig { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public object Tags { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Tags\`. @@ -10276,7 +10336,7 @@ public object Tags { get; set; } --- -##### \`Taints\`Optional +##### \`Taints\`Optional \`\`\`csharp public object Taints { get; set; } @@ -10290,13 +10350,13 @@ public object Taints { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -10304,11 +10364,11 @@ public string Version { get; set; } --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -10332,112 +10392,112 @@ new ClusterAttributes { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawseksclusterattributespropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksclusterattributespropertyclustercertificateauthoritydata) | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksclusterattributespropertyclusterendpoint) | \`string\` | The API Server endpoint URL. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksclusterattributespropertyclustersecuritygroupid) | \`string\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterattributespropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterattributespropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterattributespropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`KubectlPrivateSubnetIds\`](#amazoncdkawseksclusterattributespropertykubectlprivatesubnetids) | \`string\`[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRoleArn\`](#amazoncdkawseksclusterattributespropertykubectlrolearn) | \`string\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`KubectlSecurityGroupId\`](#amazoncdkawseksclusterattributespropertykubectlsecuritygroupid) | \`string\` | A security group to use for \`kubectl\` execution. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksclusterattributespropertyopenidconnectprovider) | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`Prune\`](#amazoncdkawseksclusterattributespropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecurityGroupIds\`](#amazoncdkawseksclusterattributespropertysecuritygroupids) | \`string\`[] | Additional security groups associated with this cluster. | -| [\`Vpc\`](#amazoncdkawseksclusterattributespropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | +| ClusterName | string | The physical name of the Cluster. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The API Server endpoint URL. | +| ClusterSecurityGroupId | string | The cluster security group that was created by Amazon EKS for the cluster. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables to use when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| KubectlPrivateSubnetIds | string[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRoleArn | string | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| KubectlSecurityGroupId | string | A security group to use for \`kubectl\` execution. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecurityGroupIds | string[] | Additional security groups associated with this cluster. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`ClusterCertificateAuthorityData\`Optional +##### \`ClusterCertificateAuthorityData\`Optional \`\`\`csharp public string ClusterCertificateAuthorityData { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Optional +##### \`ClusterEncryptionConfigKeyArn\`Optional \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Optional +##### \`ClusterEndpoint\`Optional \`\`\`csharp public string ClusterEndpoint { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`ClusterSecurityGroupId\`Optional +##### \`ClusterSecurityGroupId\`Optional \`\`\`csharp public string ClusterSecurityGroupId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -10446,26 +10506,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`KubectlPrivateSubnetIds\`Optional +##### \`KubectlPrivateSubnetIds\`Optional \`\`\`csharp public string[] KubectlPrivateSubnetIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -10474,26 +10534,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`KubectlRoleArn\`Optional +##### \`KubectlRoleArn\`Optional \`\`\`csharp public string KubectlRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`KubectlSecurityGroupId\`Optional +##### \`KubectlSecurityGroupId\`Optional \`\`\`csharp public string KubectlSecurityGroupId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -10502,13 +10562,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`OpenIdConnectProvider\`Optional +##### \`OpenIdConnectProvider\`Optional \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -10517,13 +10577,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -10532,37 +10592,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecurityGroupIds\`Optional +##### \`SecurityGroupIds\`Optional \`\`\`csharp public string[] SecurityGroupIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -10590,77 +10650,77 @@ new ClusterOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksclusteroptionspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksclusteroptionspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksclusteroptionspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksclusteroptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksclusteroptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksclusteroptionspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksclusteroptionspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksclusteroptionspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusteroptionspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksclusteroptionspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusteroptionspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksclusteroptionspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksclusteroptionspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksclusteroptionspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksclusteroptionspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -10669,52 +10729,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -10723,54 +10783,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -10779,84 +10839,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -10865,24 +10925,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -10913,80 +10973,80 @@ new ClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksclusterpropspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksclusterpropspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksclusterpropspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksclusterpropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksclusterpropspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksclusterpropspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksclusterpropspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksclusterpropspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterpropspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterpropspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterpropspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksclusterpropspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksclusterpropspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`DefaultCapacity\`](#amazoncdkawseksclusterpropspropertydefaultcapacity) | \`double\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`DefaultCapacityInstance\`](#amazoncdkawseksclusterpropspropertydefaultcapacityinstance) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`DefaultCapacityType\`](#amazoncdkawseksclusterpropspropertydefaultcapacitytype) | [\`Amazon.CDK.aws_eks.DefaultCapacityType\`](#Amazon.CDK.aws_eks.DefaultCapacityType) | The default capacity type for the cluster. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| DefaultCapacity | double | Number of instances to allocate as an initial capacity for this cluster. | +| DefaultCapacityInstance | Amazon.CDK.aws_ec2.InstanceType | The instance type to use for the default capacity. | +| DefaultCapacityType | Amazon.CDK.aws_eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -10995,52 +11055,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -11049,54 +11109,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -11105,84 +11165,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -11191,26 +11251,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`DefaultCapacity\`Optional +##### \`DefaultCapacity\`Optional \`\`\`csharp public double DefaultCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -11219,13 +11279,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`DefaultCapacityInstance\`Optional +##### \`DefaultCapacityInstance\`Optional \`\`\`csharp public InstanceType DefaultCapacityInstance { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -11234,24 +11294,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`DefaultCapacityType\`Optional +##### \`DefaultCapacityType\`Optional \`\`\`csharp public DefaultCapacityType DefaultCapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.DefaultCapacityType\`](#Amazon.CDK.aws_eks.DefaultCapacityType) +- *Type:* Amazon.CDK.aws_eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11268,66 +11328,66 @@ new CommonClusterOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawsekscommonclusteroptionspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawsekscommonclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawsekscommonclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawsekscommonclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawsekscommonclusteroptionspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawsekscommonclusteroptionspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawsekscommonclusteroptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawsekscommonclusteroptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -11336,52 +11396,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -11390,11 +11450,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11406,60 +11466,60 @@ new EksOptimizedImageProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CpuArch\`](#amazoncdkawsekseksoptimizedimagepropspropertycpuarch) | [\`Amazon.CDK.aws_eks.CpuArch\`](#Amazon.CDK.aws_eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`KubernetesVersion\`](#amazoncdkawsekseksoptimizedimagepropspropertykubernetesversion) | \`string\` | The Kubernetes version to use. | -| [\`NodeType\`](#amazoncdkawsekseksoptimizedimagepropspropertynodetype) | [\`Amazon.CDK.aws_eks.NodeType\`](#Amazon.CDK.aws_eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| CpuArch | Amazon.CDK.aws_eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| KubernetesVersion | string | The Kubernetes version to use. | +| NodeType | Amazon.CDK.aws_eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`CpuArch\`Optional +##### \`CpuArch\`Optional \`\`\`csharp public CpuArch CpuArch { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CpuArch\`](#Amazon.CDK.aws_eks.CpuArch) +- *Type:* Amazon.CDK.aws_eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`KubernetesVersion\`Optional +##### \`KubernetesVersion\`Optional \`\`\`csharp public string KubernetesVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest version The Kubernetes version to use. --- -##### \`NodeType\`Optional +##### \`NodeType\`Optional \`\`\`csharp public NodeType NodeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodeType\`](#Amazon.CDK.aws_eks.NodeType) +- *Type:* Amazon.CDK.aws_eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11470,16 +11530,16 @@ new EncryptionConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Provider\`](#amazoncdkawsekscfnclusterencryptionconfigpropertypropertyprovider) | object | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`Resources\`](#amazoncdkawsekscfnclusterencryptionconfigpropertypropertyresources) | \`string\`[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| Provider | object | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| Resources | string[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`Provider\`Optional +##### \`Provider\`Optional \`\`\`csharp public object Provider { get; set; } @@ -11493,13 +11553,13 @@ public object Provider { get; set; } --- -##### \`Resources\`Optional +##### \`Resources\`Optional \`\`\`csharp public string[] Resources { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -11507,11 +11567,11 @@ public string[] Resources { get; set; } --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11540,78 +11600,78 @@ new FargateClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksfargateclusterpropspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksfargateclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksfargateclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksfargateclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksfargateclusterpropspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksfargateclusterpropspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksfargateclusterpropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksfargateclusterpropspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksfargateclusterpropspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksfargateclusterpropspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksfargateclusterpropspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksfargateclusterpropspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksfargateclusterpropspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksfargateclusterpropspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksfargateclusterpropspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksfargateclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksfargateclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksfargateclusterpropspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`DefaultProfile\`](#amazoncdkawseksfargateclusterpropspropertydefaultprofile) | [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| DefaultProfile | Amazon.CDK.aws_eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -11620,52 +11680,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -11674,54 +11734,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -11730,84 +11790,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -11816,37 +11876,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`DefaultProfile\`Optional +##### \`DefaultProfile\`Optional \`\`\`csharp public FargateProfileOptions DefaultProfile { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) +- *Type:* Amazon.CDK.aws_eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11860,25 +11920,25 @@ new FargateProfileOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Selectors\`](#amazoncdkawseksfargateprofileoptionspropertyselectors)* | [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofileoptionspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofileoptionspropertypodexecutionrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`SubnetSelection\`](#amazoncdkawseksfargateprofileoptionspropertysubnetselection) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`Vpc\`](#amazoncdkawseksfargateprofileoptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| Selectors | Amazon.CDK.aws_eks.Selector[] | The selectors to match for pods to use this Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| SubnetSelection | Amazon.CDK.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public Selector[] Selectors { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] +- *Type:* Amazon.CDK.aws_eks.Selector[] The selectors to match for pods to use this Fargate profile. @@ -11886,43 +11946,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`PodExecutionRole\`Optional +##### \`PodExecutionRole\`Optional \`\`\`csharp public IRole PodExecutionRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`SubnetSelection\`Optional +##### \`SubnetSelection\`Optional \`\`\`csharp public SubnetSelection SubnetSelection { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -11931,13 +11991,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -11946,11 +12006,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -11965,26 +12025,26 @@ new FargateProfileProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Selectors\`](#amazoncdkawseksfargateprofilepropspropertyselectors)* | [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofilepropspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofilepropspropertypodexecutionrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`SubnetSelection\`](#amazoncdkawseksfargateprofilepropspropertysubnetselection) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`Vpc\`](#amazoncdkawseksfargateprofilepropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`Cluster\`](#amazoncdkawseksfargateprofilepropspropertycluster)* | [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| Selectors | Amazon.CDK.aws_eks.Selector[] | The selectors to match for pods to use this Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| SubnetSelection | Amazon.CDK.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| Cluster | Amazon.CDK.aws_eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public Selector[] Selectors { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] +- *Type:* Amazon.CDK.aws_eks.Selector[] The selectors to match for pods to use this Fargate profile. @@ -11992,43 +12052,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`PodExecutionRole\`Optional +##### \`PodExecutionRole\`Optional \`\`\`csharp public IRole PodExecutionRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`SubnetSelection\`Optional +##### \`SubnetSelection\`Optional \`\`\`csharp public SubnetSelection SubnetSelection { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -12037,13 +12097,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -12052,13 +12112,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public Cluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) +- *Type:* Amazon.CDK.aws_eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -12066,11 +12126,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12088,80 +12148,80 @@ new HelmChartOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Chart\`](#amazoncdkawsekshelmchartoptionspropertychart)* | \`string\` | The name of the chart. | -| [\`CreateNamespace\`](#amazoncdkawsekshelmchartoptionspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`Namespace\`](#amazoncdkawsekshelmchartoptionspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`Release\`](#amazoncdkawsekshelmchartoptionspropertyrelease) | \`string\` | The name of the release. | -| [\`Repository\`](#amazoncdkawsekshelmchartoptionspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`Timeout\`](#amazoncdkawsekshelmchartoptionspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`Values\`](#amazoncdkawsekshelmchartoptionspropertyvalues) | System.Collections.Generic.IDictionary | The values to be used by the chart. | -| [\`Version\`](#amazoncdkawsekshelmchartoptionspropertyversion) | \`string\` | The chart version to install. | -| [\`Wait\`](#amazoncdkawsekshelmchartoptionspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| Chart | string | The name of the chart. | +| CreateNamespace | bool | create namespace if not exist. | +| Namespace | string | The Kubernetes namespace scope of the requests. | +| Release | string | The name of the release. | +| Repository | string | The repository which contains the chart. | +| Timeout | Amazon.CDK.Duration | Amount of time to wait for any individual Kubernetes operation. | +| Values | System.Collections.Generic.IDictionary | The values to be used by the chart. | +| Version | string | The chart version to install. | +| Wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`Chart\`Required +##### \`Chart\`Required \`\`\`csharp public string Chart { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`CreateNamespace\`Optional +##### \`CreateNamespace\`Optional \`\`\`csharp public bool CreateNamespace { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`Release\`Optional +##### \`Release\`Optional \`\`\`csharp public string Release { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`Repository\`Optional +##### \`Repository\`Optional \`\`\`csharp public string Repository { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -12170,13 +12230,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -12185,50 +12245,50 @@ Maximum 15 minutes. --- -##### \`Values\`Optional +##### \`Values\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Values { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`Wait\`Optional +##### \`Wait\`Optional \`\`\`csharp public bool Wait { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12247,81 +12307,81 @@ new HelmChartProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Chart\`](#amazoncdkawsekshelmchartpropspropertychart)* | \`string\` | The name of the chart. | -| [\`CreateNamespace\`](#amazoncdkawsekshelmchartpropspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`Namespace\`](#amazoncdkawsekshelmchartpropspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`Release\`](#amazoncdkawsekshelmchartpropspropertyrelease) | \`string\` | The name of the release. | -| [\`Repository\`](#amazoncdkawsekshelmchartpropspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`Timeout\`](#amazoncdkawsekshelmchartpropspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`Values\`](#amazoncdkawsekshelmchartpropspropertyvalues) | System.Collections.Generic.IDictionary | The values to be used by the chart. | -| [\`Version\`](#amazoncdkawsekshelmchartpropspropertyversion) | \`string\` | The chart version to install. | -| [\`Wait\`](#amazoncdkawsekshelmchartpropspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`Cluster\`](#amazoncdkawsekshelmchartpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to apply this configuration to. | +| Chart | string | The name of the chart. | +| CreateNamespace | bool | create namespace if not exist. | +| Namespace | string | The Kubernetes namespace scope of the requests. | +| Release | string | The name of the release. | +| Repository | string | The repository which contains the chart. | +| Timeout | Amazon.CDK.Duration | Amount of time to wait for any individual Kubernetes operation. | +| Values | System.Collections.Generic.IDictionary | The values to be used by the chart. | +| Version | string | The chart version to install. | +| Wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`Chart\`Required +##### \`Chart\`Required \`\`\`csharp public string Chart { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`CreateNamespace\`Optional +##### \`CreateNamespace\`Optional \`\`\`csharp public bool CreateNamespace { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`Release\`Optional +##### \`Release\`Optional \`\`\`csharp public string Release { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`Repository\`Optional +##### \`Repository\`Optional \`\`\`csharp public string Repository { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -12330,13 +12390,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -12345,52 +12405,52 @@ Maximum 15 minutes. --- -##### \`Values\`Optional +##### \`Values\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Values { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`Wait\`Optional +##### \`Wait\`Optional \`\`\`csharp public bool Wait { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to apply this configuration to. @@ -12398,11 +12458,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12413,50 +12473,50 @@ new KubernetesManifestOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Prune\`](#amazoncdkawsekskubernetesmanifestoptionspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`SkipValidation\`](#amazoncdkawsekskubernetesmanifestoptionspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | +| Prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| SkipValidation | bool | A flag to signify if the manifest validation should be skipped. | --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`SkipValidation\`Optional +##### \`SkipValidation\`Optional \`\`\`csharp public bool SkipValidation { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12470,55 +12530,55 @@ new KubernetesManifestProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Prune\`](#amazoncdkawsekskubernetesmanifestpropspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`SkipValidation\`](#amazoncdkawsekskubernetesmanifestpropspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | -| [\`Cluster\`](#amazoncdkawsekskubernetesmanifestpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`Manifest\`](#amazoncdkawsekskubernetesmanifestpropspropertymanifest)* | System.Collections.Generic.IDictionary[] | The manifest to apply. | -| [\`Overwrite\`](#amazoncdkawsekskubernetesmanifestpropspropertyoverwrite) | \`bool\` | Overwrite any existing resources. | +| Prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| SkipValidation | bool | A flag to signify if the manifest validation should be skipped. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to apply this manifest to. | +| Manifest | System.Collections.Generic.IDictionary[] | The manifest to apply. | +| Overwrite | bool | Overwrite any existing resources. | --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`SkipValidation\`Optional +##### \`SkipValidation\`Optional \`\`\`csharp public bool SkipValidation { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to apply this manifest to. @@ -12526,13 +12586,13 @@ The EKS cluster to apply this manifest to. --- -##### \`Manifest\`Required +##### \`Manifest\`Required \`\`\`csharp public System.Collections.Generic.IDictionary[] Manifest { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary[] +- *Type:* System.Collections.Generic.IDictionary[] The manifest to apply. @@ -12540,13 +12600,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`Overwrite\`Optional +##### \`Overwrite\`Optional \`\`\`csharp public bool Overwrite { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Overwrite any existing resources. @@ -12555,11 +12615,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12569,21 +12629,21 @@ new KubernetesNetworkConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ServiceIpv4Cidr\`](#amazoncdkawsekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`string\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| ServiceIpv4Cidr | string | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`ServiceIpv4Cidr\`Optional +##### \`ServiceIpv4Cidr\`Optional \`\`\`csharp public string ServiceIpv4Cidr { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -12591,11 +12651,11 @@ public string ServiceIpv4Cidr { get; set; } --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12610,26 +12670,26 @@ new KubernetesObjectValueProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawsekskubernetesobjectvaluepropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`JsonPath\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyjsonpath)* | \`string\` | JSONPath to the specific value. | -| [\`ObjectName\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjectname)* | \`string\` | The name of the object to query. | -| [\`ObjectType\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjecttype)* | \`string\` | The object type to query. | -| [\`ObjectNamespace\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjectnamespace) | \`string\` | The namespace the object belongs to. | -| [\`Timeout\`](#amazoncdkawsekskubernetesobjectvaluepropspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Timeout for waiting on a value. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to fetch attributes from. | +| JsonPath | string | JSONPath to the specific value. | +| ObjectName | string | The name of the object to query. | +| ObjectType | string | The object type to query. | +| ObjectNamespace | string | The namespace the object belongs to. | +| Timeout | Amazon.CDK.Duration | Timeout for waiting on a value. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to fetch attributes from. @@ -12637,39 +12697,39 @@ The EKS cluster to fetch attributes from. --- -##### \`JsonPath\`Required +##### \`JsonPath\`Required \`\`\`csharp public string JsonPath { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`ObjectName\`Required +##### \`ObjectName\`Required \`\`\`csharp public string ObjectName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the object to query. --- -##### \`ObjectType\`Required +##### \`ObjectType\`Required \`\`\`csharp public string ObjectType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The object type to query. @@ -12677,37 +12737,37 @@ The object type to query. --- -##### \`ObjectNamespace\`Optional +##### \`ObjectNamespace\`Optional \`\`\`csharp public string ObjectNamespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the object belongs to. --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12722,38 +12782,38 @@ new KubernetesPatchProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ApplyPatch\`](#amazoncdkawsekskubernetespatchpropspropertyapplypatch)* | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`Cluster\`](#amazoncdkawsekskubernetespatchpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The cluster to apply the patch to. | -| [\`ResourceName\`](#amazoncdkawsekskubernetespatchpropspropertyresourcename)* | \`string\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`RestorePatch\`](#amazoncdkawsekskubernetespatchpropspropertyrestorepatch)* | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`PatchType\`](#amazoncdkawsekskubernetespatchpropspropertypatchtype) | [\`Amazon.CDK.aws_eks.PatchType\`](#Amazon.CDK.aws_eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`ResourceNamespace\`](#amazoncdkawsekskubernetespatchpropspropertyresourcenamespace) | \`string\` | The kubernetes API namespace. | +| ApplyPatch | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The cluster to apply the patch to. | +| ResourceName | string | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| RestorePatch | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| PatchType | Amazon.CDK.aws_eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| ResourceNamespace | string | The kubernetes API namespace. | --- -##### \`ApplyPatch\`Required +##### \`ApplyPatch\`Required \`\`\`csharp public System.Collections.Generic.IDictionary ApplyPatch { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The cluster to apply the patch to. @@ -12761,37 +12821,37 @@ The cluster to apply the patch to. --- -##### \`ResourceName\`Required +##### \`ResourceName\`Required \`\`\`csharp public string ResourceName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`RestorePatch\`Required +##### \`RestorePatch\`Required \`\`\`csharp public System.Collections.Generic.IDictionary RestorePatch { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`PatchType\`Optional +##### \`PatchType\`Optional \`\`\`csharp public PatchType PatchType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.PatchType\`](#Amazon.CDK.aws_eks.PatchType) +- *Type:* Amazon.CDK.aws_eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -12800,24 +12860,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`ResourceNamespace\`Optional +##### \`ResourceNamespace\`Optional \`\`\`csharp public string ResourceNamespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12828,22 +12888,22 @@ new LabelProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Key\`](#amazoncdkawsekscfnfargateprofilelabelpropertypropertykey)* | \`string\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`Value\`](#amazoncdkawsekscfnfargateprofilelabelpropertypropertyvalue)* | \`string\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| Key | string | \`CfnFargateProfile.LabelProperty.Key\`. | +| Value | string | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`Key\`Required +##### \`Key\`Required \`\`\`csharp public string Key { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Key\`. @@ -12851,13 +12911,13 @@ public string Key { get; set; } --- -##### \`Value\`Required +##### \`Value\`Required \`\`\`csharp public string Value { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Value\`. @@ -12865,11 +12925,11 @@ public string Value { get; set; } --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12880,45 +12940,45 @@ new LaunchTemplateSpec { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Id\`](#amazoncdkawsekslaunchtemplatespecpropertyid)* | \`string\` | The Launch template ID. | -| [\`Version\`](#amazoncdkawsekslaunchtemplatespecpropertyversion) | \`string\` | The launch template version to be used (optional). | +| Id | string | The Launch template ID. | +| Version | string | The launch template version to be used (optional). | --- -##### \`Id\`Required +##### \`Id\`Required \`\`\`csharp public string Id { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Launch template ID. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -12930,23 +12990,23 @@ new LaunchTemplateSpecificationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Id\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`Name\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| Id | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| Name | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| Version | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`Id\`Optional +##### \`Id\`Optional \`\`\`csharp public string Id { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -12954,13 +13014,13 @@ public string Id { get; set; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -12968,13 +13028,13 @@ public string Name { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -12982,11 +13042,11 @@ public string Version { get; set; } --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13011,62 +13071,62 @@ new NodegroupOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AmiType\`](#amazoncdkawseksnodegroupoptionspropertyamitype) | [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`CapacityType\`](#amazoncdkawseksnodegroupoptionspropertycapacitytype) | [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`DesiredSize\`](#amazoncdkawseksnodegroupoptionspropertydesiredsize) | \`double\` | The current number of worker nodes that the managed node group should maintain. | -| [\`DiskSize\`](#amazoncdkawseksnodegroupoptionspropertydisksize) | \`double\` | The root device disk size (in GiB) for your node group instances. | -| [\`ForceUpdate\`](#amazoncdkawseksnodegroupoptionspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`InstanceTypes\`](#amazoncdkawseksnodegroupoptionspropertyinstancetypes) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`Labels\`](#amazoncdkawseksnodegroupoptionspropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`LaunchTemplateSpec\`](#amazoncdkawseksnodegroupoptionspropertylaunchtemplatespec) | [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`MaxSize\`](#amazoncdkawseksnodegroupoptionspropertymaxsize) | \`double\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`MinSize\`](#amazoncdkawseksnodegroupoptionspropertyminsize) | \`double\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`NodegroupName\`](#amazoncdkawseksnodegroupoptionspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`NodeRole\`](#amazoncdkawseksnodegroupoptionspropertynoderole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`ReleaseVersion\`](#amazoncdkawseksnodegroupoptionspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`RemoteAccess\`](#amazoncdkawseksnodegroupoptionspropertyremoteaccess) | [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`Subnets\`](#amazoncdkawseksnodegroupoptionspropertysubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`Tags\`](#amazoncdkawseksnodegroupoptionspropertytags) | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | +| AmiType | Amazon.CDK.aws_eks.NodegroupAmiType | The AMI type for your node group. | +| CapacityType | Amazon.CDK.aws_eks.CapacityType | The capacity type of the nodegroup. | +| DesiredSize | double | The current number of worker nodes that the managed node group should maintain. | +| DiskSize | double | The root device disk size (in GiB) for your node group instances. | +| ForceUpdate | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| InstanceTypes | Amazon.CDK.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| LaunchTemplateSpec | Amazon.CDK.aws_eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| MaxSize | double | The maximum number of worker nodes that the managed node group can scale out to. | +| MinSize | double | The minimum number of worker nodes that the managed node group can scale in to. | +| NodegroupName | string | Name of the Nodegroup. | +| NodeRole | Amazon.CDK.aws_iam.IRole | The IAM role to associate with your node group. | +| ReleaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| RemoteAccess | Amazon.CDK.aws_eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| Subnets | Amazon.CDK.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| Tags | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public NodegroupAmiType AmiType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) +- *Type:* Amazon.CDK.aws_eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public CapacityType CapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) +- *Type:* Amazon.CDK.aws_eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -13075,26 +13135,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`ForceUpdate\`Optional +##### \`ForceUpdate\`Optional \`\`\`csharp public bool ForceUpdate { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -13103,56 +13163,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public InstanceType[] InstanceTypes { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] +- *Type:* Amazon.CDK.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`LaunchTemplateSpec\`Optional +##### \`LaunchTemplateSpec\`Optional \`\`\`csharp public LaunchTemplateSpec LaunchTemplateSpec { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) +- *Type:* Amazon.CDK.aws_eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -13161,13 +13221,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -13176,26 +13236,26 @@ This number must be greater than zero. --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`NodeRole\`Optional +##### \`NodeRole\`Optional \`\`\`csharp public IRole NodeRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -13204,26 +13264,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public NodegroupRemoteAccess RemoteAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) +- *Type:* Amazon.CDK.aws_eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -13232,13 +13292,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public SubnetSelection Subnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -13247,13 +13307,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Tags { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -13262,11 +13322,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13292,63 +13352,63 @@ new NodegroupProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AmiType\`](#amazoncdkawseksnodegrouppropspropertyamitype) | [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`CapacityType\`](#amazoncdkawseksnodegrouppropspropertycapacitytype) | [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`DesiredSize\`](#amazoncdkawseksnodegrouppropspropertydesiredsize) | \`double\` | The current number of worker nodes that the managed node group should maintain. | -| [\`DiskSize\`](#amazoncdkawseksnodegrouppropspropertydisksize) | \`double\` | The root device disk size (in GiB) for your node group instances. | -| [\`ForceUpdate\`](#amazoncdkawseksnodegrouppropspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`InstanceTypes\`](#amazoncdkawseksnodegrouppropspropertyinstancetypes) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`Labels\`](#amazoncdkawseksnodegrouppropspropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`LaunchTemplateSpec\`](#amazoncdkawseksnodegrouppropspropertylaunchtemplatespec) | [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`MaxSize\`](#amazoncdkawseksnodegrouppropspropertymaxsize) | \`double\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`MinSize\`](#amazoncdkawseksnodegrouppropspropertyminsize) | \`double\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`NodegroupName\`](#amazoncdkawseksnodegrouppropspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`NodeRole\`](#amazoncdkawseksnodegrouppropspropertynoderole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`ReleaseVersion\`](#amazoncdkawseksnodegrouppropspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`RemoteAccess\`](#amazoncdkawseksnodegrouppropspropertyremoteaccess) | [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`Subnets\`](#amazoncdkawseksnodegrouppropspropertysubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`Tags\`](#amazoncdkawseksnodegrouppropspropertytags) | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | -| [\`Cluster\`](#amazoncdkawseksnodegrouppropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | Cluster resource. | +| AmiType | Amazon.CDK.aws_eks.NodegroupAmiType | The AMI type for your node group. | +| CapacityType | Amazon.CDK.aws_eks.CapacityType | The capacity type of the nodegroup. | +| DesiredSize | double | The current number of worker nodes that the managed node group should maintain. | +| DiskSize | double | The root device disk size (in GiB) for your node group instances. | +| ForceUpdate | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| InstanceTypes | Amazon.CDK.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| LaunchTemplateSpec | Amazon.CDK.aws_eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| MaxSize | double | The maximum number of worker nodes that the managed node group can scale out to. | +| MinSize | double | The minimum number of worker nodes that the managed node group can scale in to. | +| NodegroupName | string | Name of the Nodegroup. | +| NodeRole | Amazon.CDK.aws_iam.IRole | The IAM role to associate with your node group. | +| ReleaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| RemoteAccess | Amazon.CDK.aws_eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| Subnets | Amazon.CDK.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| Tags | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | +| Cluster | Amazon.CDK.aws_eks.ICluster | Cluster resource. | --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public NodegroupAmiType AmiType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) +- *Type:* Amazon.CDK.aws_eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public CapacityType CapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) +- *Type:* Amazon.CDK.aws_eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -13357,26 +13417,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`ForceUpdate\`Optional +##### \`ForceUpdate\`Optional \`\`\`csharp public bool ForceUpdate { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -13385,56 +13445,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public InstanceType[] InstanceTypes { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] +- *Type:* Amazon.CDK.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`LaunchTemplateSpec\`Optional +##### \`LaunchTemplateSpec\`Optional \`\`\`csharp public LaunchTemplateSpec LaunchTemplateSpec { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) +- *Type:* Amazon.CDK.aws_eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -13443,13 +13503,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -13458,26 +13518,26 @@ This number must be greater than zero. --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`NodeRole\`Optional +##### \`NodeRole\`Optional \`\`\`csharp public IRole NodeRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -13486,26 +13546,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public NodegroupRemoteAccess RemoteAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) +- *Type:* Amazon.CDK.aws_eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -13514,13 +13574,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public SubnetSelection Subnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -13529,13 +13589,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Tags { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -13544,25 +13604,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13573,34 +13633,34 @@ new NodegroupRemoteAccess { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`SshKeyName\`](#amazoncdkawseksnodegroupremoteaccesspropertysshkeyname)* | \`string\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`SourceSecurityGroups\`](#amazoncdkawseksnodegroupremoteaccesspropertysourcesecuritygroups) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup)[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| SshKeyName | string | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| SourceSecurityGroups | Amazon.CDK.aws_ec2.ISecurityGroup[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`SshKeyName\`Required +##### \`SshKeyName\`Required \`\`\`csharp public string SshKeyName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`SourceSecurityGroups\`Optional +##### \`SourceSecurityGroups\`Optional \`\`\`csharp public ISecurityGroup[] SourceSecurityGroups { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup)[] +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup[] - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -13609,11 +13669,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13623,21 +13683,21 @@ new OpenIdConnectProviderProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Url\`](#amazoncdkawseksopenidconnectproviderpropspropertyurl)* | \`string\` | The URL of the identity provider. | +| Url | string | The URL of the identity provider. | --- -##### \`Url\`Required +##### \`Url\`Required \`\`\`csharp public string Url { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URL of the identity provider. @@ -13645,11 +13705,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13659,21 +13719,21 @@ new ProviderProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`KeyArn\`](#amazoncdkawsekscfnclusterproviderpropertypropertykeyarn) | \`string\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| KeyArn | string | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`KeyArn\`Optional +##### \`KeyArn\`Optional \`\`\`csharp public string KeyArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.ProviderProperty.KeyArn\`. @@ -13681,11 +13741,11 @@ public string KeyArn { get; set; } --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13696,22 +13756,22 @@ new RemoteAccessProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Ec2SshKey\`](#amazoncdkawsekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`string\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`SourceSecurityGroups\`](#amazoncdkawsekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | \`string\`[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| Ec2SshKey | string | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| SourceSecurityGroups | string[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`Ec2SshKey\`Required +##### \`Ec2SshKey\`Required \`\`\`csharp public string Ec2SshKey { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -13719,13 +13779,13 @@ public string Ec2SshKey { get; set; } --- -##### \`SourceSecurityGroups\`Optional +##### \`SourceSecurityGroups\`Optional \`\`\`csharp public string[] SourceSecurityGroups { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -13733,11 +13793,11 @@ public string[] SourceSecurityGroups { get; set; } --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13748,22 +13808,22 @@ new ResourcesVpcConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`SubnetIds\`](#amazoncdkawsekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`SecurityGroupIds\`](#amazoncdkawsekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| SubnetIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| SecurityGroupIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`SubnetIds\`Required +##### \`SubnetIds\`Required \`\`\`csharp public string[] SubnetIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -13771,13 +13831,13 @@ public string[] SubnetIds { get; set; } --- -##### \`SecurityGroupIds\`Optional +##### \`SecurityGroupIds\`Optional \`\`\`csharp public string[] SecurityGroupIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -13785,11 +13845,11 @@ public string[] SecurityGroupIds { get; set; } --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13801,23 +13861,23 @@ new ScalingConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`DesiredSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`MaxSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`MinSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertyminsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| DesiredSize | double | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| MaxSize | double | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| MinSize | double | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -13825,13 +13885,13 @@ public double DesiredSize { get; set; } --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -13839,13 +13899,13 @@ public double MaxSize { get; set; } --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -13853,11 +13913,11 @@ public double MinSize { get; set; } --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13868,22 +13928,22 @@ new Selector { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawseksselectorpropertynamespace)* | \`string\` | The Kubernetes namespace that the selector should match. | -| [\`Labels\`](#amazoncdkawseksselectorpropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels that the selector should match. | +| Namespace | string | The Kubernetes namespace that the selector should match. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels that the selector should match. | --- -##### \`Namespace\`Required +##### \`Namespace\`Required \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Kubernetes namespace that the selector should match. @@ -13891,13 +13951,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -13906,11 +13966,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13921,22 +13981,22 @@ new SelectorProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawsekscfnfargateprofileselectorpropertypropertynamespace)* | \`string\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`Labels\`](#amazoncdkawsekscfnfargateprofileselectorpropertypropertylabels) | object | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| Namespace | string | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| Labels | object | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`Namespace\`Required +##### \`Namespace\`Required \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -13944,7 +14004,7 @@ public string Namespace { get; set; } --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public object Labels { get; set; } @@ -13958,11 +14018,11 @@ public object Labels { get; set; } --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -13973,46 +14033,46 @@ new ServiceAccountOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Name\`](#amazoncdkawseksserviceaccountoptionspropertyname) | \`string\` | The name of the service account. | -| [\`Namespace\`](#amazoncdkawseksserviceaccountoptionspropertynamespace) | \`string\` | The namespace of the service account. | +| Name | string | The name of the service account. | +| Namespace | string | The namespace of the service account. | --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -14024,59 +14084,59 @@ new ServiceAccountProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Name\`](#amazoncdkawseksserviceaccountpropspropertyname) | \`string\` | The name of the service account. | -| [\`Namespace\`](#amazoncdkawseksserviceaccountpropspropertynamespace) | \`string\` | The namespace of the service account. | -| [\`Cluster\`](#amazoncdkawseksserviceaccountpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The cluster to apply the patch to. | +| Name | string | The name of the service account. | +| Namespace | string | The namespace of the service account. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The cluster to apply the patch to. | --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -14087,46 +14147,46 @@ new ServiceLoadBalancerAddressOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawseksserviceloadbalanceraddressoptionspropertynamespace) | \`string\` | The namespace the service belongs to. | -| [\`Timeout\`](#amazoncdkawseksserviceloadbalanceraddressoptionspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Timeout for waiting on the load balancer address. | +| Namespace | string | The namespace the service belongs to. | +| Timeout | Amazon.CDK.Duration | Timeout for waiting on the load balancer address. | --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the service belongs to. --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -14138,23 +14198,23 @@ new TaintProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Effect\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertyeffect) | \`string\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`Key\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertykey) | \`string\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`Value\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertyvalue) | \`string\` | \`CfnNodegroup.TaintProperty.Value\`. | +| Effect | string | \`CfnNodegroup.TaintProperty.Effect\`. | +| Key | string | \`CfnNodegroup.TaintProperty.Key\`. | +| Value | string | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`Effect\`Optional +##### \`Effect\`Optional \`\`\`csharp public string Effect { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Effect\`. @@ -14162,13 +14222,13 @@ public string Effect { get; set; } --- -##### \`Key\`Optional +##### \`Key\`Optional \`\`\`csharp public string Key { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Key\`. @@ -14176,13 +14236,13 @@ public string Key { get; set; } --- -##### \`Value\`Optional +##### \`Value\`Optional \`\`\`csharp public string Value { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Value\`. @@ -14190,15 +14250,15 @@ public string Value { get; set; } --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`Amazon.CDK.aws_ec2.IMachineImage\`](#Amazon.CDK.aws_ec2.IMachineImage) +- *Implements:* Amazon.CDK.aws_ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -14208,60 +14268,60 @@ new EksOptimizedImage(EksOptimizedImageProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Props\`](#amazoncdkawsekseksoptimizedimageparameterprops) | [\`Amazon.CDK.aws_eks.EksOptimizedImageProps\`](#Amazon.CDK.aws_eks.EksOptimizedImageProps) | *No description.* | +| Props | Amazon.CDK.aws_eks.EksOptimizedImageProps | *No description.* | --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.EksOptimizedImageProps\`](#Amazon.CDK.aws_eks.EksOptimizedImageProps) +- *Type:* Amazon.CDK.aws_eks.EksOptimizedImageProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`GetImage\`](#amazoncdkawsekseksoptimizedimagegetimage) | Return the correct image. | +| GetImage | Return the correct image. | --- -##### \`GetImage\` +##### \`GetImage\` \`\`\`csharp private GetImage(Construct Scope) \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`OnlyFrom\`](#amazoncdkawseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| OnlyFrom | Restrict public access to specific CIDR blocks. | --- -##### \`OnlyFrom\` +##### \`OnlyFrom\` \`\`\`csharp private OnlyFrom(string Cidr) \`\`\` -###### \`Cidr\`Required +###### \`Cidr\`Required -- *Type:* \`string\` +- *Type:* string CIDR blocks. @@ -14269,19 +14329,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Private\`](#amazoncdkawseksendpointaccesspropertyprivate)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`Public\`](#amazoncdkawseksendpointaccesspropertypublic)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PublicAndPrivate\`](#amazoncdkawseksendpointaccesspropertypublicandprivate)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| Private | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| Public | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PublicAndPrivate | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`Private\` +##### \`Private\`Required -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +\`\`\`csharp +public EndpointAccess Private { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -14289,9 +14353,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`Public\` +##### \`Public\`Required -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +\`\`\`csharp +public EndpointAccess Public { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -14299,9 +14367,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PublicAndPrivate\` +##### \`PublicAndPrivate\`Required + +\`\`\`csharp +public EndpointAccess PublicAndPrivate { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -14309,20 +14381,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`Of\`](#amazoncdkawsekskubernetesversionof) | Custom cluster version. | +| Of | Custom cluster version. | --- -##### \`Of\` +##### \`Of\` \`\`\`csharp using Amazon.CDK; @@ -14330,250 +14402,274 @@ using Amazon.CDK; KubernetesVersion.Of(string Version); \`\`\` -###### \`Version\`Required +###### \`Version\`Required -- *Type:* \`string\` +- *Type:* string custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawsekskubernetesversionpropertyversion)* | \`string\` | cluster version number. | +| Version | string | cluster version number. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V114\`](#amazoncdkawsekskubernetesversionpropertyv114)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V115\`](#amazoncdkawsekskubernetesversionpropertyv115)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V116\`](#amazoncdkawsekskubernetesversionpropertyv116)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V117\`](#amazoncdkawsekskubernetesversionpropertyv117)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V118\`](#amazoncdkawsekskubernetesversionpropertyv118)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V119\`](#amazoncdkawsekskubernetesversionpropertyv119)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.19. | +| V114 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.14. | +| V115 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.15. | +| V116 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.16. | +| V117 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.17. | +| V118 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.18. | +| V119 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V114\` +##### \`V114\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V114 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.14. --- -##### \`V115\` +##### \`V115\`Required + +\`\`\`csharp +public KubernetesVersion V115 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.15. --- -##### \`V116\` +##### \`V116\`Required + +\`\`\`csharp +public KubernetesVersion V116 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.16. --- -##### \`V117\` +##### \`V117\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V117 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.17. --- -##### \`V118\` +##### \`V118\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V118 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.18. --- -##### \`V119\` +##### \`V119\`Required + +\`\`\`csharp +public KubernetesVersion V119 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource), [\`Amazon.CDK.aws_ec2.IConnectable\`](#Amazon.CDK.aws_ec2.IConnectable) +- *Extends:* Amazon.CDK.IResource, Amazon.CDK.aws_ec2.IConnectable -- *Implemented By:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster), [\`Amazon.CDK.aws_eks.FargateCluster\`](#Amazon.CDK.aws_eks.FargateCluster), [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Implemented By:* Amazon.CDK.aws_eks.Cluster, Amazon.CDK.aws_eks.FargateCluster, Amazon.CDK.aws_eks.ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddCdk8sChart\`](#amazoncdkawseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`AddHelmChart\`](#amazoncdkawseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`AddManifest\`](#amazoncdkawseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`AddServiceAccount\`](#amazoncdkawseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| AddCdk8sChart | Defines a CDK8s chart in this cluster. | +| AddHelmChart | Defines a Helm chart in this cluster. | +| AddManifest | Defines a Kubernetes resource in this cluster. | +| AddServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`AddCdk8sChart\` +##### \`AddCdk8sChart\` \`\`\`csharp private AddCdk8sChart(string Id, Construct Chart) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Chart\`Required +###### \`Chart\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the cdk8s chart. --- -##### \`AddHelmChart\` +##### \`AddHelmChart\` \`\`\`csharp private AddHelmChart(string Id, HelmChartOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartOptions\`](#Amazon.CDK.aws_eks.HelmChartOptions) +- *Type:* Amazon.CDK.aws_eks.HelmChartOptions options of this chart. --- -##### \`AddManifest\` +##### \`AddManifest\` \`\`\`csharp private AddManifest(string Id, System.Collections.Generic.IDictionary Manifest) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`Manifest\`Required +###### \`Manifest\`Required -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary a list of Kubernetes resource specifications. --- -##### \`AddServiceAccount\` +##### \`AddServiceAccount\` \`\`\`csharp private AddServiceAccount(string Id, ServiceAccountOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of service account. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountOptions\`](#Amazon.CDK.aws_eks.ServiceAccountOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountOptions service account options. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawseksiclusterpropertynode)* | [\`Constructs.Node\`](#Constructs.Node) | The tree node. | -| [\`Env\`](#amazoncdkawseksiclusterpropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawseksiclusterpropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`Connections\`](#amazoncdkawseksiclusterpropertyconnections)* | [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) | *No description.* | -| [\`ClusterArn\`](#amazoncdkawseksiclusterpropertyclusterarn)* | \`string\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksiclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksiclusterpropertyclusterendpoint)* | \`string\` | The API Server endpoint URL. | -| [\`ClusterName\`](#amazoncdkawseksiclusterpropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`ClusterSecurityGroup\`](#amazoncdkawseksiclusterpropertyclustersecuritygroup)* | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksiclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksiclusterpropertyopenidconnectprovider)* | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`Prune\`](#amazoncdkawseksiclusterpropertyprune)* | \`bool\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`Vpc\`](#amazoncdkawseksiclusterpropertyvpc)* | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`KubectlEnvironment\`](#amazoncdkawseksiclusterpropertykubectlenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksiclusterpropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksiclusterpropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`KubectlPrivateSubnets\`](#amazoncdkawseksiclusterpropertykubectlprivatesubnets) | [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRole\`](#amazoncdkawseksiclusterpropertykubectlrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`KubectlSecurityGroup\`](#amazoncdkawseksiclusterpropertykubectlsecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| Node | Constructs.Node | The tree node. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| Connections | Amazon.CDK.aws_ec2.Connections | *No description.* | +| ClusterArn | string | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The API Server endpoint URL. | +| ClusterName | string | The physical name of the Cluster. | +| ClusterSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| ClusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| Prune | bool | Indicates whether Kubernetes resources can be automatically pruned. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| KubectlPrivateSubnets | Amazon.CDK.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRole | Amazon.CDK.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| KubectlSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public Node Node { get; } \`\`\` -- *Type:* [\`Constructs.Node\`](#Constructs.Node) +- *Type:* Constructs.Node The tree node. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -14581,131 +14677,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`Connections\`Required +##### \`Connections\`Required \`\`\`csharp public Connections Connections { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) +- *Type:* Amazon.CDK.aws_ec2.Connections --- -##### \`ClusterArn\`Required +##### \`ClusterArn\`Required \`\`\`csharp public string ClusterArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`ClusterCertificateAuthorityData\`Required +##### \`ClusterCertificateAuthorityData\`Required \`\`\`csharp public string ClusterCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Required +##### \`ClusterEncryptionConfigKeyArn\`Required \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Required +##### \`ClusterEndpoint\`Required \`\`\`csharp public string ClusterEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The API Server endpoint URL. --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`ClusterSecurityGroup\`Required +##### \`ClusterSecurityGroup\`Required \`\`\`csharp public ISecurityGroup ClusterSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`ClusterSecurityGroupId\`Required +##### \`ClusterSecurityGroupId\`Required \`\`\`csharp public string ClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`OpenIdConnectProvider\`Required +##### \`OpenIdConnectProvider\`Required \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`Prune\`Required +##### \`Prune\`Required \`\`\`csharp public bool Prune { get; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool Indicates whether Kubernetes resources can be automatically pruned. @@ -14713,37 +14809,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`Vpc\`Required +##### \`Vpc\`Required \`\`\`csharp public IVpc Vpc { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -14751,25 +14847,25 @@ If not defined, a default layer will be used. --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`KubectlPrivateSubnets\`Optional +##### \`KubectlPrivateSubnets\`Optional \`\`\`csharp public ISubnet[] KubectlPrivateSubnets { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] +- *Type:* Amazon.CDK.aws_ec2.ISubnet[] Subnets to host the \`kubectl\` compute resources. @@ -14777,13 +14873,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`KubectlRole\`Optional +##### \`KubectlRole\`Optional \`\`\`csharp public IRole KubectlRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -14791,13 +14887,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`KubectlSecurityGroup\`Optional +##### \`KubectlSecurityGroup\`Optional \`\`\`csharp public ISecurityGroup KubectlSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -14805,45 +14901,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource) +- *Extends:* Amazon.CDK.IResource -- *Implemented By:* [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup), [\`Amazon.CDK.aws_eks.INodegroup\`](#Amazon.CDK.aws_eks.INodegroup) +- *Implemented By:* Amazon.CDK.aws_eks.Nodegroup, Amazon.CDK.aws_eks.INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawseksinodegrouppropertynode)* | [\`Constructs.Node\`](#Constructs.Node) | The tree node. | -| [\`Env\`](#amazoncdkawseksinodegrouppropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawseksinodegrouppropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`NodegroupName\`](#amazoncdkawseksinodegrouppropertynodegroupname)* | \`string\` | Name of the nodegroup. | +| Node | Constructs.Node | The tree node. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| NodegroupName | string | Name of the nodegroup. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public Node Node { get; } \`\`\` -- *Type:* [\`Constructs.Node\`](#Constructs.Node) +- *Type:* Constructs.Node The tree node. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -14851,164 +14947,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`NodegroupName\`Required +##### \`NodegroupName\`Required \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#amazoncdkawsekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#amazoncdkawsekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#amazoncdkawsekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#amazoncdkawsekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#amazoncdkawsekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#amazoncdkawsekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#amazoncdkawseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#amazoncdkawseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#amazoncdkawseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#amazoncdkawseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#amazoncdkawseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#amazoncdkawseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#amazoncdkawseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -15016,87 +15112,87 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#amazoncdkawseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#amazoncdkawseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#amazoncdkawseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` Inferentia instances. --- -### PatchType +### PatchType | **Name** | **Description** | | --- | --- | -| [\`JSON\`](#amazoncdkawsekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#amazoncdkawsekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#amazoncdkawsekspatchtypestrategic) | Strategic merge patch. | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | --- Values for \`kubectl patch\` --type argument. -#### \`JSON\` +#### \`JSON\` JSON Patch, RFC 6902. --- -#### \`MERGE\` +#### \`MERGE\` JSON Merge patch. --- -#### \`STRATEGIC\` +#### \`STRATEGIC\` Strategic merge patch. @@ -16319,15 +16415,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -16337,116 +16433,116 @@ new AwsAuth(Construct Scope, string Id, AwsAuthProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksawsauthparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksawsauthparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksawsauthparameterprops)* | [\`Amazon.CDK.aws_eks.AwsAuthProps\`](#Amazon.CDK.aws_eks.AwsAuthProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.AwsAuthProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthProps\`](#Amazon.CDK.aws_eks.AwsAuthProps) +- *Type:* Amazon.CDK.aws_eks.AwsAuthProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddAccount\`](#amazoncdkawseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`AddMastersRole\`](#amazoncdkawseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`AddRoleMapping\`](#amazoncdkawseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`AddUserMapping\`](#amazoncdkawseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| AddAccount | Additional AWS account to add to the aws-auth configmap. | +| AddMastersRole | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| AddRoleMapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| AddUserMapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`AddAccount\` +##### \`AddAccount\` \`\`\`csharp private AddAccount(string AccountId) \`\`\` -###### \`AccountId\`Required +###### \`AccountId\`Required -- *Type:* \`string\` +- *Type:* string account number. --- -##### \`AddMastersRole\` +##### \`AddMastersRole\` \`\`\`csharp private AddMastersRole(IRole Role, string Username = null) \`\`\` -###### \`Role\`Required +###### \`Role\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The IAM role to add. --- -###### \`Username\`Optional +###### \`Username\`Optional -- *Type:* \`string\` +- *Type:* string Optional user (defaults to the role ARN). --- -##### \`AddRoleMapping\` +##### \`AddRoleMapping\` \`\`\`csharp private AddRoleMapping(IRole Role, AwsAuthMapping Mapping) \`\`\` -###### \`Role\`Required +###### \`Role\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The IAM role to map. --- -###### \`Mapping\`Required +###### \`Mapping\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthMapping\`](#Amazon.CDK.aws_eks.AwsAuthMapping) +- *Type:* Amazon.CDK.aws_eks.AwsAuthMapping Mapping to k8s user name and groups. --- -##### \`AddUserMapping\` +##### \`AddUserMapping\` \`\`\`csharp private AddUserMapping(IUser User, AwsAuthMapping Mapping) \`\`\` -###### \`User\`Required +###### \`User\`Required -- *Type:* [\`Amazon.CDK.aws_iam.IUser\`](#Amazon.CDK.aws_iam.IUser) +- *Type:* Amazon.CDK.aws_iam.IUser The IAM user to map. --- -###### \`Mapping\`Required +###### \`Mapping\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuthMapping\`](#Amazon.CDK.aws_eks.AwsAuthMapping) +- *Type:* Amazon.CDK.aws_eks.AwsAuthMapping Mapping to k8s user name and groups. @@ -16455,15 +16551,15 @@ Mapping to k8s user name and groups. -### CfnAddon +### CfnAddon -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -16473,90 +16569,90 @@ new CfnAddon(Construct Scope, string Id, CfnAddonProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnaddonparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnaddonparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnaddonparameterprops)* | [\`Amazon.CDK.aws_eks.CfnAddonProps\`](#Amazon.CDK.aws_eks.CfnAddonProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnAddonProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnAddonProps\`](#Amazon.CDK.aws_eks.CfnAddonProps) +- *Type:* Amazon.CDK.aws_eks.CfnAddonProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnaddonpropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnaddonpropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`AddonName\`](#amazoncdkawsekscfnaddonpropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnaddonpropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`AddonVersion\`](#amazoncdkawsekscfnaddonpropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`ResolveConflicts\`](#amazoncdkawsekscfnaddonpropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`ServiceAccountRoleArn\`](#amazoncdkawsekscfnaddonpropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::Addon.Tags\`. | +| AddonName | string | \`AWS::EKS::Addon.AddonName\`. | +| ClusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| AddonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| ResolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| ServiceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::Addon.Tags\`. @@ -16564,13 +16660,13 @@ public TagManager Tags { get; } --- -##### \`AddonName\`Required +##### \`AddonName\`Required \`\`\`csharp public string AddonName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -16578,13 +16674,13 @@ public string AddonName { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -16592,13 +16688,13 @@ public string ClusterName { get; } --- -##### \`AddonVersion\`Optional +##### \`AddonVersion\`Optional \`\`\`csharp public string AddonVersion { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -16606,13 +16702,13 @@ public string AddonVersion { get; } --- -##### \`ResolveConflicts\`Optional +##### \`ResolveConflicts\`Optional \`\`\`csharp public string ResolveConflicts { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -16620,13 +16716,13 @@ public string ResolveConflicts { get; } --- -##### \`ServiceAccountRoleArn\`Optional +##### \`ServiceAccountRoleArn\`Optional \`\`\`csharp public string ServiceAccountRoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -16634,31 +16730,35 @@ public string ServiceAccountRoleArn { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnaddonpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required + +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -16668,139 +16768,139 @@ new CfnCluster(Construct Scope, string Id, CfnClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnclusterparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnclusterparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnclusterparameterprops)* | [\`Amazon.CDK.aws_eks.CfnClusterProps\`](#Amazon.CDK.aws_eks.CfnClusterProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnClusterProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnClusterProps\`](#Amazon.CDK.aws_eks.CfnClusterProps) +- *Type:* Amazon.CDK.aws_eks.CfnClusterProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnclusterpropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrCertificateAuthorityData\`](#amazoncdkawsekscfnclusterpropertyattrcertificateauthoritydata)* | \`string\` | *No description.* | -| [\`AttrClusterSecurityGroupId\`](#amazoncdkawsekscfnclusterpropertyattrclustersecuritygroupid)* | \`string\` | *No description.* | -| [\`AttrEncryptionConfigKeyArn\`](#amazoncdkawsekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`string\` | *No description.* | -| [\`AttrEndpoint\`](#amazoncdkawsekscfnclusterpropertyattrendpoint)* | \`string\` | *No description.* | -| [\`AttrOpenIdConnectIssuerUrl\`](#amazoncdkawsekscfnclusterpropertyattropenidconnectissuerurl)* | \`string\` | *No description.* | -| [\`ResourcesVpcConfig\`](#amazoncdkawsekscfnclusterpropertyresourcesvpcconfig)* | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`RoleArn\`](#amazoncdkawsekscfnclusterpropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`EncryptionConfig\`](#amazoncdkawsekscfnclusterpropertyencryptionconfig) | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`KubernetesNetworkConfig\`](#amazoncdkawsekscfnclusterpropertykubernetesnetworkconfig) | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`Name\`](#amazoncdkawsekscfnclusterpropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnclusterpropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| AttrArn | string | *No description.* | +| AttrCertificateAuthorityData | string | *No description.* | +| AttrClusterSecurityGroupId | string | *No description.* | +| AttrEncryptionConfigKeyArn | string | *No description.* | +| AttrEndpoint | string | *No description.* | +| AttrOpenIdConnectIssuerUrl | string | *No description.* | +| ResourcesVpcConfig | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| RoleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| EncryptionConfig | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| KubernetesNetworkConfig | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| Name | string | \`AWS::EKS::Cluster.Name\`. | +| Version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrCertificateAuthorityData\`Required +##### \`AttrCertificateAuthorityData\`Required \`\`\`csharp public string AttrCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrClusterSecurityGroupId\`Required +##### \`AttrClusterSecurityGroupId\`Required \`\`\`csharp public string AttrClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrEncryptionConfigKeyArn\`Required +##### \`AttrEncryptionConfigKeyArn\`Required \`\`\`csharp public string AttrEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrEndpoint\`Required +##### \`AttrEndpoint\`Required \`\`\`csharp public string AttrEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrOpenIdConnectIssuerUrl\`Required +##### \`AttrOpenIdConnectIssuerUrl\`Required \`\`\`csharp public string AttrOpenIdConnectIssuerUrl { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`ResourcesVpcConfig\`Required +##### \`ResourcesVpcConfig\`Required \`\`\`csharp public object ResourcesVpcConfig { get; } @@ -16814,13 +16914,13 @@ public object ResourcesVpcConfig { get; } --- -##### \`RoleArn\`Required +##### \`RoleArn\`Required \`\`\`csharp public string RoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -16828,7 +16928,7 @@ public string RoleArn { get; } --- -##### \`EncryptionConfig\`Optional +##### \`EncryptionConfig\`Optional \`\`\`csharp public object EncryptionConfig { get; } @@ -16842,7 +16942,7 @@ public object EncryptionConfig { get; } --- -##### \`KubernetesNetworkConfig\`Optional +##### \`KubernetesNetworkConfig\`Optional \`\`\`csharp public object KubernetesNetworkConfig { get; } @@ -16856,13 +16956,13 @@ public object KubernetesNetworkConfig { get; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -16870,13 +16970,13 @@ public string Name { get; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -16884,31 +16984,35 @@ public string Version { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnclusterpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -16918,90 +17022,90 @@ new CfnFargateProfile(Construct Scope, string Id, CfnFargateProfileProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnfargateprofileparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnfargateprofileparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnfargateprofileparameterprops)* | [\`Amazon.CDK.aws_eks.CfnFargateProfileProps\`](#Amazon.CDK.aws_eks.CfnFargateProfileProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnFargateProfileProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnFargateProfileProps\`](#Amazon.CDK.aws_eks.CfnFargateProfileProps) +- *Type:* Amazon.CDK.aws_eks.CfnFargateProfileProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnfargateprofilepropertyattrarn)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnfargateprofilepropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnfargateprofilepropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`PodExecutionRoleArn\`](#amazoncdkawsekscfnfargateprofilepropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`Selectors\`](#amazoncdkawsekscfnfargateprofilepropertyselectors)* | object | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`FargateProfileName\`](#amazoncdkawsekscfnfargateprofilepropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`Subnets\`](#amazoncdkawsekscfnfargateprofilepropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| AttrArn | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| ClusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| PodExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| Selectors | object | \`AWS::EKS::FargateProfile.Selectors\`. | +| FargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| Subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -17009,13 +17113,13 @@ public TagManager Tags { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -17023,13 +17127,13 @@ public string ClusterName { get; } --- -##### \`PodExecutionRoleArn\`Required +##### \`PodExecutionRoleArn\`Required \`\`\`csharp public string PodExecutionRoleArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -17037,7 +17141,7 @@ public string PodExecutionRoleArn { get; } --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public object Selectors { get; } @@ -17051,13 +17155,13 @@ public object Selectors { get; } --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -17065,13 +17169,13 @@ public string FargateProfileName { get; } --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public string[] Subnets { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -17079,31 +17183,35 @@ public string[] Subnets { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnfargateprofilepropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`Amazon.CDK.IInspectable\`](#Amazon.CDK.IInspectable) +- *Implements:* Amazon.CDK.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -17113,123 +17221,123 @@ new CfnNodegroup(Construct Scope, string Id, CfnNodegroupProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekscfnnodegroupparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsekscfnnodegroupparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsekscfnnodegroupparameterprops)* | [\`Amazon.CDK.aws_eks.CfnNodegroupProps\`](#Amazon.CDK.aws_eks.CfnNodegroupProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | Amazon.CDK.aws_eks.CfnNodegroupProps | - resource properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.CfnNodegroupProps\`](#Amazon.CDK.aws_eks.CfnNodegroupProps) +- *Type:* Amazon.CDK.aws_eks.CfnNodegroupProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`Inspect\`](#amazoncdkawsekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| Inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`Inspect\` +##### \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -###### \`Inspector\`Required +###### \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AttrArn\`](#amazoncdkawsekscfnnodegrouppropertyattrarn)* | \`string\` | *No description.* | -| [\`AttrClusterName\`](#amazoncdkawsekscfnnodegrouppropertyattrclustername)* | \`string\` | *No description.* | -| [\`AttrNodegroupName\`](#amazoncdkawsekscfnnodegrouppropertyattrnodegroupname)* | \`string\` | *No description.* | -| [\`Tags\`](#amazoncdkawsekscfnnodegrouppropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnnodegrouppropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`Labels\`](#amazoncdkawsekscfnnodegrouppropertylabels)* | \`object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`NodeRole\`](#amazoncdkawsekscfnnodegrouppropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`Subnets\`](#amazoncdkawsekscfnnodegrouppropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`AmiType\`](#amazoncdkawsekscfnnodegrouppropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`CapacityType\`](#amazoncdkawsekscfnnodegrouppropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`DiskSize\`](#amazoncdkawsekscfnnodegrouppropertydisksize) | \`double\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`ForceUpdateEnabled\`](#amazoncdkawsekscfnnodegrouppropertyforceupdateenabled) | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`InstanceTypes\`](#amazoncdkawsekscfnnodegrouppropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`LaunchTemplate\`](#amazoncdkawsekscfnnodegrouppropertylaunchtemplate) | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`NodegroupName\`](#amazoncdkawsekscfnnodegrouppropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`ReleaseVersion\`](#amazoncdkawsekscfnnodegrouppropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`RemoteAccess\`](#amazoncdkawsekscfnnodegrouppropertyremoteaccess) | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`ScalingConfig\`](#amazoncdkawsekscfnnodegrouppropertyscalingconfig) | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`Taints\`](#amazoncdkawsekscfnnodegrouppropertytaints) | object | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouppropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| AttrArn | string | *No description.* | +| AttrClusterName | string | *No description.* | +| AttrNodegroupName | string | *No description.* | +| Tags | Amazon.CDK.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| ClusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| Labels | object | \`AWS::EKS::Nodegroup.Labels\`. | +| NodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| Subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| AmiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| CapacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| DiskSize | double | \`AWS::EKS::Nodegroup.DiskSize\`. | +| ForceUpdateEnabled | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| InstanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| LaunchTemplate | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| NodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| ReleaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| RemoteAccess | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| ScalingConfig | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| Taints | object | \`AWS::EKS::Nodegroup.Taints\`. | +| Version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`AttrArn\`Required +##### \`AttrArn\`Required \`\`\`csharp public string AttrArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrClusterName\`Required +##### \`AttrClusterName\`Required \`\`\`csharp public string AttrClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`AttrNodegroupName\`Required +##### \`AttrNodegroupName\`Required \`\`\`csharp public string AttrNodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -17237,13 +17345,13 @@ public TagManager Tags { get; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -17251,13 +17359,13 @@ public string ClusterName { get; } --- -##### \`Labels\`Required +##### \`Labels\`Required \`\`\`csharp public object Labels { get; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Labels\`. @@ -17265,13 +17373,13 @@ public object Labels { get; } --- -##### \`NodeRole\`Required +##### \`NodeRole\`Required \`\`\`csharp public string NodeRole { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -17279,13 +17387,13 @@ public string NodeRole { get; } --- -##### \`Subnets\`Required +##### \`Subnets\`Required \`\`\`csharp public string[] Subnets { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -17293,13 +17401,13 @@ public string[] Subnets { get; } --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public string AmiType { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -17307,13 +17415,13 @@ public string AmiType { get; } --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public string CapacityType { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -17321,13 +17429,13 @@ public string CapacityType { get; } --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`AWS::EKS::Nodegroup.DiskSize\`. @@ -17335,7 +17443,7 @@ public double DiskSize { get; } --- -##### \`ForceUpdateEnabled\`Optional +##### \`ForceUpdateEnabled\`Optional \`\`\`csharp public object ForceUpdateEnabled { get; } @@ -17349,13 +17457,13 @@ public object ForceUpdateEnabled { get; } --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public string[] InstanceTypes { get; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -17363,7 +17471,7 @@ public string[] InstanceTypes { get; } --- -##### \`LaunchTemplate\`Optional +##### \`LaunchTemplate\`Optional \`\`\`csharp public object LaunchTemplate { get; } @@ -17377,13 +17485,13 @@ public object LaunchTemplate { get; } --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -17391,13 +17499,13 @@ public string NodegroupName { get; } --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -17405,7 +17513,7 @@ public string ReleaseVersion { get; } --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public object RemoteAccess { get; } @@ -17419,7 +17527,7 @@ public object RemoteAccess { get; } --- -##### \`ScalingConfig\`Optional +##### \`ScalingConfig\`Optional \`\`\`csharp public object ScalingConfig { get; } @@ -17433,7 +17541,7 @@ public object ScalingConfig { get; } --- -##### \`Taints\`Optional +##### \`Taints\`Optional \`\`\`csharp public object Taints { get; } @@ -17447,13 +17555,13 @@ public object Taints { get; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -17461,31 +17569,35 @@ public string Version { get; } --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CfnResourceTypeName\`](#amazoncdkawsekscfnnodegrouppropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CfnResourceTypeName | string | The CloudFormation resource type name for this resource class. | --- -##### \`CfnResourceTypeName\` +##### \`CfnResourceTypeName\`Required -- *Type:* \`string\` +\`\`\`csharp +public string CfnResourceTypeName { get; } +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Implements:* Amazon.CDK.aws_eks.ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -17495,251 +17607,251 @@ new Cluster(Construct Scope, string Id, ClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksclusterparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`Id\`](#amazoncdkawseksclusterparameterid)* | \`string\` | the id of the Construct to create. | -| [\`Props\`](#amazoncdkawseksclusterparameterprops)* | [\`Amazon.CDK.aws_eks.ClusterProps\`](#Amazon.CDK.aws_eks.ClusterProps) | properties in the IClusterProps interface. | +| Scope | Constructs.Construct | a Construct, most likely a cdk.Stack created. | +| Id | string | the id of the Construct to create. | +| Props | Amazon.CDK.aws_eks.ClusterProps | properties in the IClusterProps interface. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id of the Construct to create. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ClusterProps\`](#Amazon.CDK.aws_eks.ClusterProps) +- *Type:* Amazon.CDK.aws_eks.ClusterProps properties in the IClusterProps interface. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddAutoScalingGroupCapacity\`](#amazoncdkawseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`AddCdk8sChart\`](#amazoncdkawseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`AddFargateProfile\`](#amazoncdkawseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`AddHelmChart\`](#amazoncdkawseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`AddManifest\`](#amazoncdkawseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`AddNodegroupCapacity\`](#amazoncdkawseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`AddServiceAccount\`](#amazoncdkawseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`ConnectAutoScalingGroupCapacity\`](#amazoncdkawseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`GetServiceLoadBalancerAddress\`](#amazoncdkawseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| AddAutoScalingGroupCapacity | Add nodes to this EKS cluster. | +| AddCdk8sChart | Defines a CDK8s chart in this cluster. | +| AddFargateProfile | Adds a Fargate profile to this cluster. | +| AddHelmChart | Defines a Helm chart in this cluster. | +| AddManifest | Defines a Kubernetes resource in this cluster. | +| AddNodegroupCapacity | Add managed nodegroup to this Amazon EKS cluster. | +| AddServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | +| ConnectAutoScalingGroupCapacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| GetServiceLoadBalancerAddress | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`AddAutoScalingGroupCapacity\` +##### \`AddAutoScalingGroupCapacity\` \`\`\`csharp private AddAutoScalingGroupCapacity(string Id, AutoScalingGroupCapacityOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions\`](#Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions) +- *Type:* Amazon.CDK.aws_eks.AutoScalingGroupCapacityOptions --- -##### \`AddCdk8sChart\` +##### \`AddCdk8sChart\` \`\`\`csharp private AddCdk8sChart(string Id, Construct Chart) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Chart\`Required +###### \`Chart\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the cdk8s chart. --- -##### \`AddFargateProfile\` +##### \`AddFargateProfile\` \`\`\`csharp private AddFargateProfile(string Id, FargateProfileOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id of this profile. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) +- *Type:* Amazon.CDK.aws_eks.FargateProfileOptions profile options. --- -##### \`AddHelmChart\` +##### \`AddHelmChart\` \`\`\`csharp private AddHelmChart(string Id, HelmChartOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartOptions\`](#Amazon.CDK.aws_eks.HelmChartOptions) +- *Type:* Amazon.CDK.aws_eks.HelmChartOptions options of this chart. --- -##### \`AddManifest\` +##### \`AddManifest\` \`\`\`csharp private AddManifest(string Id, System.Collections.Generic.IDictionary Manifest) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`Manifest\`Required +###### \`Manifest\`Required -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary a list of Kubernetes resource specifications. --- -##### \`AddNodegroupCapacity\` +##### \`AddNodegroupCapacity\` \`\`\`csharp private AddNodegroupCapacity(string Id, NodegroupOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The ID of the nodegroup. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupOptions\`](#Amazon.CDK.aws_eks.NodegroupOptions) +- *Type:* Amazon.CDK.aws_eks.NodegroupOptions options for creating a new nodegroup. --- -##### \`AddServiceAccount\` +##### \`AddServiceAccount\` \`\`\`csharp private AddServiceAccount(string Id, ServiceAccountOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountOptions\`](#Amazon.CDK.aws_eks.ServiceAccountOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountOptions --- -##### \`ConnectAutoScalingGroupCapacity\` +##### \`ConnectAutoScalingGroupCapacity\` \`\`\`csharp private ConnectAutoScalingGroupCapacity(AutoScalingGroup AutoScalingGroup, AutoScalingGroupOptions Options) \`\`\` -###### \`AutoScalingGroup\`Required +###### \`AutoScalingGroup\`Required -- *Type:* [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) +- *Type:* Amazon.CDK.aws_autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.AutoScalingGroupOptions\`](#Amazon.CDK.aws_eks.AutoScalingGroupOptions) +- *Type:* Amazon.CDK.aws_eks.AutoScalingGroupOptions options for adding auto scaling groups, like customizing the bootstrap script. --- -##### \`GetServiceLoadBalancerAddress\` +##### \`GetServiceLoadBalancerAddress\` \`\`\`csharp private GetServiceLoadBalancerAddress(string ServiceName, ServiceLoadBalancerAddressOptions Options = null) \`\`\` -###### \`ServiceName\`Required +###### \`ServiceName\`Required -- *Type:* \`string\` +- *Type:* string The name of the service. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions\`](#Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceLoadBalancerAddressOptions Additional operation options. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`FromClusterAttributes\`](#amazoncdkawseksclusterfromclusterattributes) | Import an existing cluster. | +| FromClusterAttributes | Import an existing cluster. | --- -##### \`FromClusterAttributes\` +##### \`FromClusterAttributes\` \`\`\`csharp using Amazon.CDK; @@ -17747,68 +17859,68 @@ using Amazon.CDK; Cluster.FromClusterAttributes(Construct Scope, string Id, ClusterAttributes Attrs); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the construct scope, in most cases 'this'. --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string the id or name to import as. --- -###### \`Attrs\`Required +###### \`Attrs\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ClusterAttributes\`](#Amazon.CDK.aws_eks.ClusterAttributes) +- *Type:* Amazon.CDK.aws_eks.ClusterAttributes the cluster properties to use for importing information. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AdminRole\`](#amazoncdkawseksclusterpropertyadminrole)* | [\`Amazon.CDK.aws_iam.Role\`](#Amazon.CDK.aws_iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`AwsAuth\`](#amazoncdkawseksclusterpropertyawsauth)* | [\`Amazon.CDK.aws_eks.AwsAuth\`](#Amazon.CDK.aws_eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`ClusterArn\`](#amazoncdkawseksclusterpropertyclusterarn)* | \`string\` | The AWS generated ARN for the Cluster resource. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksclusterpropertyclusterendpoint)* | \`string\` | The endpoint URL for the Cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusterpropertyclustername)* | \`string\` | The Name of the created EKS Cluster. | -| [\`ClusterOpenIdConnectIssuer\`](#amazoncdkawseksclusterpropertyclusteropenidconnectissuer)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`ClusterOpenIdConnectIssuerUrl\`](#amazoncdkawseksclusterpropertyclusteropenidconnectissuerurl)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`ClusterSecurityGroup\`](#amazoncdkawseksclusterpropertyclustersecuritygroup)* | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`Connections\`](#amazoncdkawseksclusterpropertyconnections)* | [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksclusterpropertyopenidconnectprovider)* | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`Prune\`](#amazoncdkawseksclusterpropertyprune)* | \`bool\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`Role\`](#amazoncdkawseksclusterpropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`Vpc\`](#amazoncdkawseksclusterpropertyvpc)* | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`DefaultCapacity\`](#amazoncdkawseksclusterpropertydefaultcapacity) | [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`DefaultNodegroup\`](#amazoncdkawseksclusterpropertydefaultnodegroup) | [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterpropertykubectlenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterpropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterpropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`KubectlPrivateSubnets\`](#amazoncdkawseksclusterpropertykubectlprivatesubnets) | [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRole\`](#amazoncdkawseksclusterpropertykubectlrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`KubectlSecurityGroup\`](#amazoncdkawseksclusterpropertykubectlsecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| AdminRole | Amazon.CDK.aws_iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| AwsAuth | Amazon.CDK.aws_eks.AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| ClusterArn | string | The AWS generated ARN for the Cluster resource. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The endpoint URL for the Cluster. | +| ClusterName | string | The Name of the created EKS Cluster. | +| ClusterOpenIdConnectIssuer | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| ClusterOpenIdConnectIssuerUrl | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| ClusterSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| ClusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| Connections | Amazon.CDK.aws_ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| Prune | bool | Determines if Kubernetes resources can be pruned automatically. | +| Role | Amazon.CDK.aws_iam.IRole | IAM role assumed by the EKS Control Plane. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| DefaultCapacity | Amazon.CDK.aws_autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| DefaultNodegroup | Amazon.CDK.aws_eks.Nodegroup | The node group that hosts the default capacity for this cluster. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| KubectlPrivateSubnets | Amazon.CDK.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRole | Amazon.CDK.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| KubectlSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`AdminRole\`Required +##### \`AdminRole\`Required \`\`\`csharp public Role AdminRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.Role\`](#Amazon.CDK.aws_iam.Role) +- *Type:* Amazon.CDK.aws_iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -17816,61 +17928,61 @@ This role also has \`systems:master\` permissions. --- -##### \`AwsAuth\`Required +##### \`AwsAuth\`Required \`\`\`csharp public AwsAuth AwsAuth { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.AwsAuth\`](#Amazon.CDK.aws_eks.AwsAuth) +- *Type:* Amazon.CDK.aws_eks.AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`ClusterArn\`Required +##### \`ClusterArn\`Required \`\`\`csharp public string ClusterArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The AWS generated ARN for the Cluster resource. --- -##### \`ClusterCertificateAuthorityData\`Required +##### \`ClusterCertificateAuthorityData\`Required \`\`\`csharp public string ClusterCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Required +##### \`ClusterEncryptionConfigKeyArn\`Required \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Required +##### \`ClusterEndpoint\`Required \`\`\`csharp public string ClusterEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The endpoint URL for the Cluster. @@ -17878,25 +17990,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Name of the created EKS Cluster. --- -##### \`ClusterOpenIdConnectIssuer\`Required +##### \`ClusterOpenIdConnectIssuer\`Required \`\`\`csharp public string ClusterOpenIdConnectIssuer { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -17904,13 +18016,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`ClusterOpenIdConnectIssuerUrl\`Required +##### \`ClusterOpenIdConnectIssuerUrl\`Required \`\`\`csharp public string ClusterOpenIdConnectIssuerUrl { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -17918,49 +18030,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`ClusterSecurityGroup\`Required +##### \`ClusterSecurityGroup\`Required \`\`\`csharp public ISecurityGroup ClusterSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`ClusterSecurityGroupId\`Required +##### \`ClusterSecurityGroupId\`Required \`\`\`csharp public string ClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`Connections\`Required +##### \`Connections\`Required \`\`\`csharp public Connections Connections { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) +- *Type:* Amazon.CDK.aws_ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`OpenIdConnectProvider\`Required +##### \`OpenIdConnectProvider\`Required \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -17968,49 +18080,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`Prune\`Required +##### \`Prune\`Required \`\`\`csharp public bool Prune { get; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool Determines if Kubernetes resources can be pruned automatically. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`Vpc\`Required +##### \`Vpc\`Required \`\`\`csharp public IVpc Vpc { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`DefaultCapacity\`Optional +##### \`DefaultCapacity\`Optional \`\`\`csharp public AutoScalingGroup DefaultCapacity { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.AutoScalingGroup\`](#Amazon.CDK.aws_autoscaling.AutoScalingGroup) +- *Type:* Amazon.CDK.aws_autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -18018,13 +18130,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`DefaultNodegroup\`Optional +##### \`DefaultNodegroup\`Optional \`\`\`csharp public Nodegroup DefaultNodegroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup) +- *Type:* Amazon.CDK.aws_eks.Nodegroup The node group that hosts the default capacity for this cluster. @@ -18032,25 +18144,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -18058,38 +18170,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`KubectlPrivateSubnets\`Optional +##### \`KubectlPrivateSubnets\`Optional \`\`\`csharp public ISubnet[] KubectlPrivateSubnets { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] +- *Type:* Amazon.CDK.aws_ec2.ISubnet[] - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`KubectlRole\`Optional +##### \`KubectlRole\`Optional \`\`\`csharp public IRole KubectlRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -18097,13 +18209,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`KubectlSecurityGroup\`Optional +##### \`KubectlSecurityGroup\`Optional \`\`\`csharp public ISecurityGroup KubectlSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -18111,13 +18223,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18127,27 +18239,27 @@ new FargateCluster(Construct Scope, string Id, FargateClusterProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksfargateclusterparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksfargateclusterparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksfargateclusterparameterprops)* | [\`Amazon.CDK.aws_eks.FargateClusterProps\`](#Amazon.CDK.aws_eks.FargateClusterProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.FargateClusterProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateClusterProps\`](#Amazon.CDK.aws_eks.FargateClusterProps) +- *Type:* Amazon.CDK.aws_eks.FargateClusterProps --- @@ -18155,15 +18267,15 @@ new FargateCluster(Construct Scope, string Id, FargateClusterProps Props); -### FargateProfile +### FargateProfile -- *Implements:* [\`Amazon.CDK.ITaggable\`](#Amazon.CDK.ITaggable) +- *Implements:* Amazon.CDK.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18173,74 +18285,74 @@ new FargateProfile(Construct Scope, string Id, FargateProfileProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksfargateprofileparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksfargateprofileparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksfargateprofileparameterprops)* | [\`Amazon.CDK.aws_eks.FargateProfileProps\`](#Amazon.CDK.aws_eks.FargateProfileProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.FargateProfileProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileProps\`](#Amazon.CDK.aws_eks.FargateProfileProps) +- *Type:* Amazon.CDK.aws_eks.FargateProfileProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`FargateProfileArn\`](#amazoncdkawseksfargateprofilepropertyfargateprofilearn)* | \`string\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofilepropertyfargateprofilename)* | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofilepropertypodexecutionrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`Tags\`](#amazoncdkawseksfargateprofilepropertytags)* | [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) | Resource tags. | +| FargateProfileArn | string | The full Amazon Resource Name (ARN) of the Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| Tags | Amazon.CDK.TagManager | Resource tags. | --- -##### \`FargateProfileArn\`Required +##### \`FargateProfileArn\`Required \`\`\`csharp public string FargateProfileArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`FargateProfileName\`Required +##### \`FargateProfileName\`Required \`\`\`csharp public string FargateProfileName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the Fargate profile. --- -##### \`PodExecutionRole\`Required +##### \`PodExecutionRole\`Required \`\`\`csharp public IRole PodExecutionRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -18248,26 +18360,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`Tags\`Required +##### \`Tags\`Required \`\`\`csharp public TagManager Tags { get; } \`\`\` -- *Type:* [\`Amazon.CDK.TagManager\`](#Amazon.CDK.TagManager) +- *Type:* Amazon.CDK.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18277,56 +18389,60 @@ new HelmChart(Construct Scope, string Id, HelmChartProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekshelmchartparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekshelmchartparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekshelmchartparameterprops)* | [\`Amazon.CDK.aws_eks.HelmChartProps\`](#Amazon.CDK.aws_eks.HelmChartProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.HelmChartProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartProps\`](#Amazon.CDK.aws_eks.HelmChartProps) +- *Type:* Amazon.CDK.aws_eks.HelmChartProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekshelmchartpropertyresourcetype)* | \`string\` | The CloudFormation resource type. | +| ResourceType | string | The CloudFormation resource type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required + +\`\`\`csharp +public string ResourceType { get; } +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18336,56 +18452,60 @@ new KubernetesManifest(Construct Scope, string Id, KubernetesManifestProps Props | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetesmanifestparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetesmanifestparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetesmanifestparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesManifestProps\`](#Amazon.CDK.aws_eks.KubernetesManifestProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesManifestProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesManifestProps\`](#Amazon.CDK.aws_eks.KubernetesManifestProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesManifestProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekskubernetesmanifestpropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| ResourceType | string | The CloudFormation reosurce type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required -- *Type:* \`string\` +\`\`\`csharp +public string ResourceType { get; } +\`\`\` + +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18395,75 +18515,79 @@ new KubernetesObjectValue(Construct Scope, string Id, KubernetesObjectValueProps | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetesobjectvalueparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetesobjectvalueparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetesobjectvalueparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesObjectValueProps\`](#Amazon.CDK.aws_eks.KubernetesObjectValueProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesObjectValueProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesObjectValueProps\`](#Amazon.CDK.aws_eks.KubernetesObjectValueProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesObjectValueProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Value\`](#amazoncdkawsekskubernetesobjectvaluepropertyvalue)* | \`string\` | The value as a string token. | +| Value | string | The value as a string token. | --- -##### \`Value\`Required +##### \`Value\`Required \`\`\`csharp public string Value { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourceType\`](#amazoncdkawsekskubernetesobjectvaluepropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| ResourceType | string | The CloudFormation reosurce type. | --- -##### \`ResourceType\` +##### \`ResourceType\`Required -- *Type:* \`string\` +\`\`\`csharp +public string ResourceType { get; } +\`\`\` + +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18473,27 +18597,27 @@ new KubernetesPatch(Construct Scope, string Id, KubernetesPatchProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsekskubernetespatchparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawsekskubernetespatchparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawsekskubernetespatchparameterprops)* | [\`Amazon.CDK.aws_eks.KubernetesPatchProps\`](#Amazon.CDK.aws_eks.KubernetesPatchProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.KubernetesPatchProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesPatchProps\`](#Amazon.CDK.aws_eks.KubernetesPatchProps) +- *Type:* Amazon.CDK.aws_eks.KubernetesPatchProps --- @@ -18501,13 +18625,13 @@ new KubernetesPatch(Construct Scope, string Id, KubernetesPatchProps Props); -### Nodegroup +### Nodegroup -- *Implements:* [\`Amazon.CDK.aws_eks.INodegroup\`](#Amazon.CDK.aws_eks.INodegroup) +- *Implements:* Amazon.CDK.aws_eks.INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18517,40 +18641,40 @@ new Nodegroup(Construct Scope, string Id, NodegroupProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksnodegroupparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksnodegroupparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksnodegroupparameterprops)* | [\`Amazon.CDK.aws_eks.NodegroupProps\`](#Amazon.CDK.aws_eks.NodegroupProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.NodegroupProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupProps\`](#Amazon.CDK.aws_eks.NodegroupProps) +- *Type:* Amazon.CDK.aws_eks.NodegroupProps --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`FromNodegroupName\`](#amazoncdkawseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| FromNodegroupName | Import the Nodegroup from attributes. | --- -##### \`FromNodegroupName\` +##### \`FromNodegroupName\` \`\`\`csharp using Amazon.CDK; @@ -18558,93 +18682,93 @@ using Amazon.CDK; Nodegroup.FromNodegroupName(Construct Scope, string Id, string NodegroupName); \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`NodegroupName\`Required +###### \`NodegroupName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawseksnodegrouppropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | the Amazon EKS cluster resource. | -| [\`NodegroupArn\`](#amazoncdkawseksnodegrouppropertynodegrouparn)* | \`string\` | ARN of the nodegroup. | -| [\`NodegroupName\`](#amazoncdkawseksnodegrouppropertynodegroupname)* | \`string\` | Nodegroup name. | -| [\`Role\`](#amazoncdkawseksnodegrouppropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | IAM role of the instance profile for the nodegroup. | +| Cluster | Amazon.CDK.aws_eks.ICluster | the Amazon EKS cluster resource. | +| NodegroupArn | string | ARN of the nodegroup. | +| NodegroupName | string | Nodegroup name. | +| Role | Amazon.CDK.aws_iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster the Amazon EKS cluster resource. --- -##### \`NodegroupArn\`Required +##### \`NodegroupArn\`Required \`\`\`csharp public string NodegroupArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string ARN of the nodegroup. --- -##### \`NodegroupName\`Required +##### \`NodegroupName\`Required \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Nodegroup name. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18654,31 +18778,31 @@ new OpenIdConnectProvider(Construct Scope, string Id, OpenIdConnectProviderProps | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksopenidconnectproviderparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | The definition scope. | -| [\`Id\`](#amazoncdkawseksopenidconnectproviderparameterid)* | \`string\` | Construct ID. | -| [\`Props\`](#amazoncdkawseksopenidconnectproviderparameterprops)* | [\`Amazon.CDK.aws_eks.OpenIdConnectProviderProps\`](#Amazon.CDK.aws_eks.OpenIdConnectProviderProps) | Initialization properties. | +| Scope | Constructs.Construct | The definition scope. | +| Id | string | Construct ID. | +| Props | Amazon.CDK.aws_eks.OpenIdConnectProviderProps | Initialization properties. | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct The definition scope. --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string Construct ID. --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.OpenIdConnectProviderProps\`](#Amazon.CDK.aws_eks.OpenIdConnectProviderProps) +- *Type:* Amazon.CDK.aws_eks.OpenIdConnectProviderProps Initialization properties. @@ -18688,13 +18812,13 @@ Initialization properties. -### ServiceAccount +### ServiceAccount -- *Implements:* [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) +- *Implements:* Amazon.CDK.aws_iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -18704,157 +18828,157 @@ new ServiceAccount(Construct Scope, string Id, ServiceAccountProps Props); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawseksserviceaccountparameterscope)* | [\`Constructs.Construct\`](#Constructs.Construct) | *No description.* | -| [\`Id\`](#amazoncdkawseksserviceaccountparameterid)* | \`string\` | *No description.* | -| [\`Props\`](#amazoncdkawseksserviceaccountparameterprops)* | [\`Amazon.CDK.aws_eks.ServiceAccountProps\`](#Amazon.CDK.aws_eks.ServiceAccountProps) | *No description.* | +| Scope | Constructs.Construct | *No description.* | +| Id | string | *No description.* | +| Props | Amazon.CDK.aws_eks.ServiceAccountProps | *No description.* | --- -##### \`Scope\`Required +##### \`Scope\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct --- -##### \`Id\`Required +##### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`Props\`Required +##### \`Props\`Required -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountProps\`](#Amazon.CDK.aws_eks.ServiceAccountProps) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddToPolicy\`](#amazoncdkawseksserviceaccountaddtopolicy) | Add to the policy of this principal. | -| [\`AddToPrincipalPolicy\`](#amazoncdkawseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| AddToPolicy | Add to the policy of this principal. | +| AddToPrincipalPolicy | Add to the policy of this principal. | --- -##### ~~\`AddToPolicy\`~~ +##### ~~\`AddToPolicy\`~~ \`\`\`csharp private AddToPolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.aws_iam.PolicyStatement\`](#Amazon.CDK.aws_iam.PolicyStatement) +- *Type:* Amazon.CDK.aws_iam.PolicyStatement --- -##### \`AddToPrincipalPolicy\` +##### \`AddToPrincipalPolicy\` \`\`\`csharp private AddToPrincipalPolicy(PolicyStatement Statement) \`\`\` -###### \`Statement\`Required +###### \`Statement\`Required -- *Type:* [\`Amazon.CDK.aws_iam.PolicyStatement\`](#Amazon.CDK.aws_iam.PolicyStatement) +- *Type:* Amazon.CDK.aws_iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AssumeRoleAction\`](#amazoncdkawseksserviceaccountpropertyassumeroleaction)* | \`string\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`GrantPrincipal\`](#amazoncdkawseksserviceaccountpropertygrantprincipal)* | [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) | The principal to grant permissions to. | -| [\`PolicyFragment\`](#amazoncdkawseksserviceaccountpropertypolicyfragment)* | [\`Amazon.CDK.aws_iam.PrincipalPolicyFragment\`](#Amazon.CDK.aws_iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`Role\`](#amazoncdkawseksserviceaccountpropertyrole)* | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The role which is linked to the service account. | -| [\`ServiceAccountName\`](#amazoncdkawseksserviceaccountpropertyserviceaccountname)* | \`string\` | The name of the service account. | -| [\`ServiceAccountNamespace\`](#amazoncdkawseksserviceaccountpropertyserviceaccountnamespace)* | \`string\` | The namespace where the service account is located in. | +| AssumeRoleAction | string | When this Principal is used in an AssumeRole policy, the action to use. | +| GrantPrincipal | Amazon.CDK.aws_iam.IPrincipal | The principal to grant permissions to. | +| PolicyFragment | Amazon.CDK.aws_iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| Role | Amazon.CDK.aws_iam.IRole | The role which is linked to the service account. | +| ServiceAccountName | string | The name of the service account. | +| ServiceAccountNamespace | string | The namespace where the service account is located in. | --- -##### \`AssumeRoleAction\`Required +##### \`AssumeRoleAction\`Required \`\`\`csharp public string AssumeRoleAction { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`GrantPrincipal\`Required +##### \`GrantPrincipal\`Required \`\`\`csharp public IPrincipal GrantPrincipal { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IPrincipal\`](#Amazon.CDK.aws_iam.IPrincipal) +- *Type:* Amazon.CDK.aws_iam.IPrincipal The principal to grant permissions to. --- -##### \`PolicyFragment\`Required +##### \`PolicyFragment\`Required \`\`\`csharp public PrincipalPolicyFragment PolicyFragment { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.PrincipalPolicyFragment\`](#Amazon.CDK.aws_iam.PrincipalPolicyFragment) +- *Type:* Amazon.CDK.aws_iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`Role\`Required +##### \`Role\`Required \`\`\`csharp public IRole Role { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole The role which is linked to the service account. --- -##### \`ServiceAccountName\`Required +##### \`ServiceAccountName\`Required \`\`\`csharp public string ServiceAccountName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the service account. --- -##### \`ServiceAccountNamespace\`Required +##### \`ServiceAccountNamespace\`Required \`\`\`csharp public string ServiceAccountNamespace { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -18895,78 +19019,78 @@ new AutoScalingGroupCapacityOptions { }; \`\`\` -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`AllowAllOutbound\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`bool\` | Whether the instances can initiate connections to anywhere by default. | -| [\`AssociatePublicIpAddress\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`bool\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`AutoScalingGroupName\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`string\` | The name of the Auto Scaling group. | -| [\`BlockDevices\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyblockdevices) | [\`Amazon.CDK.aws_autoscaling.BlockDevice\`](#Amazon.CDK.aws_autoscaling.BlockDevice)[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`Cooldown\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertycooldown) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`DesiredCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`double\` | Initial amount of instances in the fleet. | -| [\`GroupMetrics\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertygroupmetrics) | [\`Amazon.CDK.aws_autoscaling.GroupMetrics\`](#Amazon.CDK.aws_autoscaling.GroupMetrics)[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`HealthCheck\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`Amazon.CDK.aws_autoscaling.HealthCheck\`](#Amazon.CDK.aws_autoscaling.HealthCheck) | Configuration for health checks. | -| [\`IgnoreUnmodifiedSizeProperties\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`bool\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`InstanceMonitoring\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`Amazon.CDK.aws_autoscaling.Monitoring\`](#Amazon.CDK.aws_autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`KeyName\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertykeyname) | \`string\` | Name of SSH keypair to grant access to instances. | -| [\`MaxCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`double\` | Maximum number of instances in the fleet. | -| [\`MaxInstanceLifetime\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The maximum amount of time that an instance can be in service. | -| [\`MinCapacity\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymincapacity) | \`double\` | Minimum number of instances in the fleet. | -| [\`NewInstancesProtectedFromScaleIn\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`bool\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`Notifications\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertynotifications) | [\`Amazon.CDK.aws_autoscaling.NotificationConfiguration\`](#Amazon.CDK.aws_autoscaling.NotificationConfiguration)[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`NotificationsTopic\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertynotificationstopic) | [\`Amazon.CDK.aws_sns.ITopic\`](#Amazon.CDK.aws_sns.ITopic) | SNS topic to send notifications about fleet changes. | -| [\`ReplacingUpdateMinSuccessfulInstancesPercent\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyreplacingupdateminsuccessfulinstancespercent) | \`double\` | Configuration for replacing updates. | -| [\`ResourceSignalCount\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyresourcesignalcount) | \`double\` | How many ResourceSignal calls CloudFormation expects before the resource is considered created. | -| [\`ResourceSignalTimeout\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyresourcesignaltimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | The length of time to wait for the resourceSignalCount. | -| [\`RollingUpdateConfiguration\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyrollingupdateconfiguration) | [\`Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration\`](#Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration) | Configuration for rolling updates. | -| [\`Signals\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertysignals) | [\`Amazon.CDK.aws_autoscaling.Signals\`](#Amazon.CDK.aws_autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`SpotPrice\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyspotprice) | \`string\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`UpdatePolicy\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`Amazon.CDK.aws_autoscaling.UpdatePolicy\`](#Amazon.CDK.aws_autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`UpdateType\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyupdatetype) | [\`Amazon.CDK.aws_autoscaling.UpdateType\`](#Amazon.CDK.aws_autoscaling.UpdateType) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`VpcSubnets\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`InstanceType\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | Instance type of the instances to start. | -| [\`BootstrapEnabled\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`BootstrapOptions\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`MachineImageType\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) | Machine image type. | -| [\`MapRole\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`SpotInterruptHandler\`](#amazoncdkawseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | - ---- - -##### \`AllowAllOutbound\`Optional +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| AllowAllOutbound | bool | Whether the instances can initiate connections to anywhere by default. | +| AssociatePublicIpAddress | bool | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| AutoScalingGroupName | string | The name of the Auto Scaling group. | +| BlockDevices | Amazon.CDK.aws_autoscaling.BlockDevice[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| Cooldown | Amazon.CDK.Duration | Default scaling cooldown for this AutoScalingGroup. | +| DesiredCapacity | double | Initial amount of instances in the fleet. | +| GroupMetrics | Amazon.CDK.aws_autoscaling.GroupMetrics[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| HealthCheck | Amazon.CDK.aws_autoscaling.HealthCheck | Configuration for health checks. | +| IgnoreUnmodifiedSizeProperties | bool | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| InstanceMonitoring | Amazon.CDK.aws_autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| KeyName | string | Name of SSH keypair to grant access to instances. | +| MaxCapacity | double | Maximum number of instances in the fleet. | +| MaxInstanceLifetime | Amazon.CDK.Duration | The maximum amount of time that an instance can be in service. | +| MinCapacity | double | Minimum number of instances in the fleet. | +| NewInstancesProtectedFromScaleIn | bool | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| Notifications | Amazon.CDK.aws_autoscaling.NotificationConfiguration[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| NotificationsTopic | Amazon.CDK.aws_sns.ITopic | SNS topic to send notifications about fleet changes. | +| ReplacingUpdateMinSuccessfulInstancesPercent | double | Configuration for replacing updates. | +| ResourceSignalCount | double | How many ResourceSignal calls CloudFormation expects before the resource is considered created. | +| ResourceSignalTimeout | Amazon.CDK.Duration | The length of time to wait for the resourceSignalCount. | +| RollingUpdateConfiguration | Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration | Configuration for rolling updates. | +| Signals | Amazon.CDK.aws_autoscaling.Signals | Configure waiting for signals during deployment. | +| SpotPrice | string | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| UpdatePolicy | Amazon.CDK.aws_autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| UpdateType | Amazon.CDK.aws_autoscaling.UpdateType | What to do when an AutoScalingGroup's instance configuration is changed. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection | Where to place instances within the VPC. | +| InstanceType | Amazon.CDK.aws_ec2.InstanceType | Instance type of the instances to start. | +| BootstrapEnabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| BootstrapOptions | Amazon.CDK.aws_eks.BootstrapOptions | EKS node bootstrapping options. | +| MachineImageType | Amazon.CDK.aws_eks.MachineImageType | Machine image type. | +| MapRole | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| SpotInterruptHandler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | + +--- + +##### \`AllowAllOutbound\`Optional \`\`\`csharp public bool AllowAllOutbound { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`AssociatePublicIpAddress\`Optional +##### \`AssociatePublicIpAddress\`Optional \`\`\`csharp public bool AssociatePublicIpAddress { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`AutoScalingGroupName\`Optional +##### \`AutoScalingGroupName\`Optional \`\`\`csharp public string AutoScalingGroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -18975,60 +19099,60 @@ This name must be unique per Region per account. --- -##### \`BlockDevices\`Optional +##### \`BlockDevices\`Optional \`\`\`csharp public BlockDevice[] BlockDevices { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.BlockDevice\`](#Amazon.CDK.aws_autoscaling.BlockDevice)[] +- *Type:* Amazon.CDK.aws_autoscaling.BlockDevice[] - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`Cooldown\`Optional +##### \`Cooldown\`Optional \`\`\`csharp public Duration Cooldown { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`DesiredCapacity\`Optional +##### \`DesiredCapacity\`Optional \`\`\`csharp public double DesiredCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`GroupMetrics\`Optional +##### \`GroupMetrics\`Optional \`\`\`csharp public GroupMetrics[] GroupMetrics { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.GroupMetrics\`](#Amazon.CDK.aws_autoscaling.GroupMetrics)[] +- *Type:* Amazon.CDK.aws_autoscaling.GroupMetrics[] - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -19037,26 +19161,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`HealthCheck\`Optional +##### \`HealthCheck\`Optional \`\`\`csharp public HealthCheck HealthCheck { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.HealthCheck\`](#Amazon.CDK.aws_autoscaling.HealthCheck) +- *Type:* Amazon.CDK.aws_autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`IgnoreUnmodifiedSizeProperties\`Optional +##### \`IgnoreUnmodifiedSizeProperties\`Optional \`\`\`csharp public bool IgnoreUnmodifiedSizeProperties { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -19065,86 +19189,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`InstanceMonitoring\`Optional +##### \`InstanceMonitoring\`Optional \`\`\`csharp public Monitoring InstanceMonitoring { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.Monitoring\`](#Amazon.CDK.aws_autoscaling.Monitoring) +- *Type:* Amazon.CDK.aws_autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`KeyName\`Optional +##### \`KeyName\`Optional \`\`\`csharp public string KeyName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`MaxCapacity\`Optional +##### \`MaxCapacity\`Optional \`\`\`csharp public double MaxCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`MaxInstanceLifetime\`Optional +##### \`MaxInstanceLifetime\`Optional \`\`\`csharp public Duration MaxInstanceLifetime { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`MinCapacity\`Optional +##### \`MinCapacity\`Optional \`\`\`csharp public double MinCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`NewInstancesProtectedFromScaleIn\`Optional +##### \`NewInstancesProtectedFromScaleIn\`Optional \`\`\`csharp public bool NewInstancesProtectedFromScaleIn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -19153,22 +19277,22 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`Notifications\`Optional +##### \`Notifications\`Optional \`\`\`csharp public NotificationConfiguration[] Notifications { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.NotificationConfiguration\`](#Amazon.CDK.aws_autoscaling.NotificationConfiguration)[] +- *Type:* Amazon.CDK.aws_autoscaling.NotificationConfiguration[] - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### ~~\`NotificationsTopic\`~~Optional +##### ~~\`NotificationsTopic\`~~Optional - *Deprecated:* use \`notifications\` @@ -19176,14 +19300,14 @@ Configure autoscaling group to send notifications about fleet changes to an SNS public ITopic NotificationsTopic { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_sns.ITopic\`](#Amazon.CDK.aws_sns.ITopic) +- *Type:* Amazon.CDK.aws_sns.ITopic - *Default:* No fleet change notifications will be sent. SNS topic to send notifications about fleet changes. --- -##### ~~\`ReplacingUpdateMinSuccessfulInstancesPercent\`~~Optional +##### ~~\`ReplacingUpdateMinSuccessfulInstancesPercent\`~~Optional - *Deprecated:* Use \`signals\` instead @@ -19191,7 +19315,7 @@ SNS topic to send notifications about fleet changes. public double ReplacingUpdateMinSuccessfulInstancesPercent { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* minSuccessfulInstancesPercent Configuration for replacing updates. @@ -19200,7 +19324,7 @@ Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instan --- -##### ~~\`ResourceSignalCount\`~~Optional +##### ~~\`ResourceSignalCount\`~~Optional - *Deprecated:* Use \`signals\` instead. @@ -19208,14 +19332,14 @@ Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instan public double ResourceSignalCount { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 if resourceSignalTimeout is set, 0 otherwise How many ResourceSignal calls CloudFormation expects before the resource is considered created. --- -##### ~~\`ResourceSignalTimeout\`~~Optional +##### ~~\`ResourceSignalTimeout\`~~Optional - *Deprecated:* Use \`signals\` instead. @@ -19223,7 +19347,7 @@ How many ResourceSignal calls CloudFormation expects before the resource is cons public Duration ResourceSignalTimeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) if resourceSignalCount is set, N/A otherwise The length of time to wait for the resourceSignalCount. @@ -19232,7 +19356,7 @@ The maximum value is 43200 (12 hours). --- -##### ~~\`RollingUpdateConfiguration\`~~Optional +##### ~~\`RollingUpdateConfiguration\`~~Optional - *Deprecated:* Use \`updatePolicy\` instead @@ -19240,7 +19364,7 @@ The maximum value is 43200 (12 hours). public RollingUpdateConfiguration RollingUpdateConfiguration { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration\`](#Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration) +- *Type:* Amazon.CDK.aws_autoscaling.RollingUpdateConfiguration - *Default:* RollingUpdateConfiguration with defaults. Configuration for rolling updates. @@ -19249,13 +19373,13 @@ Only used if updateType == UpdateType.RollingUpdate. --- -##### \`Signals\`Optional +##### \`Signals\`Optional \`\`\`csharp public Signals Signals { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.Signals\`](#Amazon.CDK.aws_autoscaling.Signals) +- *Type:* Amazon.CDK.aws_autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -19264,13 +19388,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`SpotPrice\`Optional +##### \`SpotPrice\`Optional \`\`\`csharp public string SpotPrice { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -19279,13 +19403,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`UpdatePolicy\`Optional +##### \`UpdatePolicy\`Optional \`\`\`csharp public UpdatePolicy UpdatePolicy { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.UpdatePolicy\`](#Amazon.CDK.aws_autoscaling.UpdatePolicy) +- *Type:* Amazon.CDK.aws_autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -19294,7 +19418,7 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### ~~\`UpdateType\`~~Optional +##### ~~\`UpdateType\`~~Optional - *Deprecated:* Use \`updatePolicy\` instead @@ -19302,7 +19426,7 @@ This is applied when any of the settings on the ASG are changed that affect how public UpdateType UpdateType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_autoscaling.UpdateType\`](#Amazon.CDK.aws_autoscaling.UpdateType) +- *Type:* Amazon.CDK.aws_autoscaling.UpdateType - *Default:* UpdateType.None What to do when an AutoScalingGroup's instance configuration is changed. @@ -19311,38 +19435,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`InstanceType\`Required +##### \`InstanceType\`Required \`\`\`csharp public InstanceType InstanceType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType Instance type of the instances to start. --- -##### \`BootstrapEnabled\`Optional +##### \`BootstrapEnabled\`Optional \`\`\`csharp public bool BootstrapEnabled { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -19351,39 +19475,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`BootstrapOptions\`Optional +##### \`BootstrapOptions\`Optional \`\`\`csharp public BootstrapOptions BootstrapOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) +- *Type:* Amazon.CDK.aws_eks.BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`MachineImageType\`Optional +##### \`MachineImageType\`Optional \`\`\`csharp public MachineImageType MachineImageType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) +- *Type:* Amazon.CDK.aws_eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`MapRole\`Optional +##### \`MapRole\`Optional \`\`\`csharp public bool MapRole { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -19392,13 +19516,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`SpotInterruptHandler\`Optional +##### \`SpotInterruptHandler\`Optional \`\`\`csharp public bool SpotInterruptHandler { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -19407,11 +19531,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19425,25 +19549,25 @@ new AutoScalingGroupOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`BootstrapEnabled\`](#amazoncdkawseksautoscalinggroupoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`BootstrapOptions\`](#amazoncdkawseksautoscalinggroupoptionspropertybootstrapoptions) | [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`MachineImageType\`](#amazoncdkawseksautoscalinggroupoptionspropertymachineimagetype) | [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`MapRole\`](#amazoncdkawseksautoscalinggroupoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`SpotInterruptHandler\`](#amazoncdkawseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| BootstrapEnabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| BootstrapOptions | Amazon.CDK.aws_eks.BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| MachineImageType | Amazon.CDK.aws_eks.MachineImageType | Allow options to specify different machine image type. | +| MapRole | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| SpotInterruptHandler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`BootstrapEnabled\`Optional +##### \`BootstrapEnabled\`Optional \`\`\`csharp public bool BootstrapEnabled { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -19452,39 +19576,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`BootstrapOptions\`Optional +##### \`BootstrapOptions\`Optional \`\`\`csharp public BootstrapOptions BootstrapOptions { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.BootstrapOptions\`](#Amazon.CDK.aws_eks.BootstrapOptions) +- *Type:* Amazon.CDK.aws_eks.BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`MachineImageType\`Optional +##### \`MachineImageType\`Optional \`\`\`csharp public MachineImageType MachineImageType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.MachineImageType\`](#Amazon.CDK.aws_eks.MachineImageType) +- *Type:* Amazon.CDK.aws_eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`MapRole\`Optional +##### \`MapRole\`Optional \`\`\`csharp public bool MapRole { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -19493,13 +19617,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`SpotInterruptHandler\`Optional +##### \`SpotInterruptHandler\`Optional \`\`\`csharp public bool SpotInterruptHandler { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -19508,11 +19632,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19523,47 +19647,47 @@ new AwsAuthMapping { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Groups\`](#amazoncdkawseksawsauthmappingpropertygroups)* | \`string\`[] | A list of groups within Kubernetes to which the role is mapped. | -| [\`Username\`](#amazoncdkawseksawsauthmappingpropertyusername) | \`string\` | The user name within Kubernetes to map to the IAM role. | +| Groups | string[] | A list of groups within Kubernetes to which the role is mapped. | +| Username | string | The user name within Kubernetes to map to the IAM role. | --- -##### \`Groups\`Required +##### \`Groups\`Required \`\`\`csharp public string[] Groups { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`Username\`Optional +##### \`Username\`Optional \`\`\`csharp public string Username { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19573,21 +19697,21 @@ new AwsAuthProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawseksawsauthpropspropertycluster)* | [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) | The EKS cluster to apply this configuration to. | +| Cluster | Amazon.CDK.aws_eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public Cluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) +- *Type:* Amazon.CDK.aws_eks.Cluster The EKS cluster to apply this configuration to. @@ -19595,11 +19719,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19615,94 +19739,94 @@ new BootstrapOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AdditionalArgs\`](#amazoncdkawseksbootstrapoptionspropertyadditionalargs) | \`string\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`AwsApiRetryAttempts\`](#amazoncdkawseksbootstrapoptionspropertyawsapiretryattempts) | \`double\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`DnsClusterIp\`](#amazoncdkawseksbootstrapoptionspropertydnsclusterip) | \`string\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`DockerConfigJson\`](#amazoncdkawseksbootstrapoptionspropertydockerconfigjson) | \`string\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`EnableDockerBridge\`](#amazoncdkawseksbootstrapoptionspropertyenabledockerbridge) | \`bool\` | Restores the docker default bridge network. | -| [\`KubeletExtraArgs\`](#amazoncdkawseksbootstrapoptionspropertykubeletextraargs) | \`string\` | Extra arguments to add to the kubelet. | -| [\`UseMaxPods\`](#amazoncdkawseksbootstrapoptionspropertyusemaxpods) | \`bool\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| AdditionalArgs | string | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| AwsApiRetryAttempts | double | Number of retry attempts for AWS API call (DescribeCluster). | +| DnsClusterIp | string | Overrides the IP address to use for DNS queries within the cluster. | +| DockerConfigJson | string | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| EnableDockerBridge | bool | Restores the docker default bridge network. | +| KubeletExtraArgs | string | Extra arguments to add to the kubelet. | +| UseMaxPods | bool | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`AdditionalArgs\`Optional +##### \`AdditionalArgs\`Optional \`\`\`csharp public string AdditionalArgs { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`AwsApiRetryAttempts\`Optional +##### \`AwsApiRetryAttempts\`Optional \`\`\`csharp public double AwsApiRetryAttempts { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`DnsClusterIp\`Optional +##### \`DnsClusterIp\`Optional \`\`\`csharp public string DnsClusterIp { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`DockerConfigJson\`Optional +##### \`DockerConfigJson\`Optional \`\`\`csharp public string DockerConfigJson { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`EnableDockerBridge\`Optional +##### \`EnableDockerBridge\`Optional \`\`\`csharp public bool EnableDockerBridge { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Restores the docker default bridge network. --- -##### \`KubeletExtraArgs\`Optional +##### \`KubeletExtraArgs\`Optional \`\`\`csharp public string KubeletExtraArgs { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Extra arguments to add to the kubelet. @@ -19711,26 +19835,26 @@ Useful for adding labels or taints. --- -##### \`UseMaxPods\`Optional +##### \`UseMaxPods\`Optional \`\`\`csharp public bool UseMaxPods { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19745,26 +19869,26 @@ new CfnAddonProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AddonName\`](#amazoncdkawsekscfnaddonpropspropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`ClusterName\`](#amazoncdkawsekscfnaddonpropspropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`AddonVersion\`](#amazoncdkawsekscfnaddonpropspropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`ResolveConflicts\`](#amazoncdkawsekscfnaddonpropspropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`ServiceAccountRoleArn\`](#amazoncdkawsekscfnaddonpropspropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`Tags\`](#amazoncdkawsekscfnaddonpropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::EKS::Addon.Tags\`. | +| AddonName | string | \`AWS::EKS::Addon.AddonName\`. | +| ClusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| AddonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| ResolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| ServiceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::EKS::Addon.Tags\`. | --- -##### \`AddonName\`Required +##### \`AddonName\`Required \`\`\`csharp public string AddonName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -19772,13 +19896,13 @@ public string AddonName { get; set; } --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -19786,13 +19910,13 @@ public string ClusterName { get; set; } --- -##### \`AddonVersion\`Optional +##### \`AddonVersion\`Optional \`\`\`csharp public string AddonVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -19800,13 +19924,13 @@ public string AddonVersion { get; set; } --- -##### \`ResolveConflicts\`Optional +##### \`ResolveConflicts\`Optional \`\`\`csharp public string ResolveConflicts { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -19814,13 +19938,13 @@ public string ResolveConflicts { get; set; } --- -##### \`ServiceAccountRoleArn\`Optional +##### \`ServiceAccountRoleArn\`Optional \`\`\`csharp public string ServiceAccountRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -19828,13 +19952,13 @@ public string ServiceAccountRoleArn { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::EKS::Addon.Tags\`. @@ -19842,13 +19966,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19863,20 +19987,20 @@ new CfnClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ResourcesVpcConfig\`](#amazoncdkawsekscfnclusterpropspropertyresourcesvpcconfig)* | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`RoleArn\`](#amazoncdkawsekscfnclusterpropspropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`EncryptionConfig\`](#amazoncdkawsekscfnclusterpropspropertyencryptionconfig) | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`KubernetesNetworkConfig\`](#amazoncdkawsekscfnclusterpropspropertykubernetesnetworkconfig) | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`Name\`](#amazoncdkawsekscfnclusterpropspropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnclusterpropspropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| ResourcesVpcConfig | object | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| RoleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| EncryptionConfig | object | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| KubernetesNetworkConfig | object | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| Name | string | \`AWS::EKS::Cluster.Name\`. | +| Version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`ResourcesVpcConfig\`Required +##### \`ResourcesVpcConfig\`Required \`\`\`csharp public object ResourcesVpcConfig { get; set; } @@ -19890,13 +20014,13 @@ public object ResourcesVpcConfig { get; set; } --- -##### \`RoleArn\`Required +##### \`RoleArn\`Required \`\`\`csharp public string RoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -19904,7 +20028,7 @@ public string RoleArn { get; set; } --- -##### \`EncryptionConfig\`Optional +##### \`EncryptionConfig\`Optional \`\`\`csharp public object EncryptionConfig { get; set; } @@ -19918,7 +20042,7 @@ public object EncryptionConfig { get; set; } --- -##### \`KubernetesNetworkConfig\`Optional +##### \`KubernetesNetworkConfig\`Optional \`\`\`csharp public object KubernetesNetworkConfig { get; set; } @@ -19932,13 +20056,13 @@ public object KubernetesNetworkConfig { get; set; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -19946,13 +20070,13 @@ public string Name { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -19960,13 +20084,13 @@ public string Version { get; set; } --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -19981,26 +20105,26 @@ new CfnFargateProfileProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawsekscfnfargateprofilepropspropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`PodExecutionRoleArn\`](#amazoncdkawsekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`Selectors\`](#amazoncdkawsekscfnfargateprofilepropspropertyselectors)* | object | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`FargateProfileName\`](#amazoncdkawsekscfnfargateprofilepropspropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`Subnets\`](#amazoncdkawsekscfnfargateprofilepropspropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`Tags\`](#amazoncdkawsekscfnfargateprofilepropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::EKS::FargateProfile.Tags\`. | +| ClusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| PodExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| Selectors | object | \`AWS::EKS::FargateProfile.Selectors\`. | +| FargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| Subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -20008,13 +20132,13 @@ public string ClusterName { get; set; } --- -##### \`PodExecutionRoleArn\`Required +##### \`PodExecutionRoleArn\`Required \`\`\`csharp public string PodExecutionRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -20022,7 +20146,7 @@ public string PodExecutionRoleArn { get; set; } --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public object Selectors { get; set; } @@ -20036,13 +20160,13 @@ public object Selectors { get; set; } --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -20050,13 +20174,13 @@ public string FargateProfileName { get; set; } --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public string[] Subnets { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -20064,13 +20188,13 @@ public string[] Subnets { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::EKS::FargateProfile.Tags\`. @@ -20078,13 +20202,13 @@ public CfnTag[] Tags { get; set; } --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -20110,37 +20234,37 @@ new CfnNodegroupProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawsekscfnnodegrouppropspropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`NodeRole\`](#amazoncdkawsekscfnnodegrouppropspropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`Subnets\`](#amazoncdkawsekscfnnodegrouppropspropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`AmiType\`](#amazoncdkawsekscfnnodegrouppropspropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`CapacityType\`](#amazoncdkawsekscfnnodegrouppropspropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`DiskSize\`](#amazoncdkawsekscfnnodegrouppropspropertydisksize) | \`double\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`ForceUpdateEnabled\`](#amazoncdkawsekscfnnodegrouppropspropertyforceupdateenabled) | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`InstanceTypes\`](#amazoncdkawsekscfnnodegrouppropspropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`Labels\`](#amazoncdkawsekscfnnodegrouppropspropertylabels) | \`object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`LaunchTemplate\`](#amazoncdkawsekscfnnodegrouppropspropertylaunchtemplate) | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`NodegroupName\`](#amazoncdkawsekscfnnodegrouppropspropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`ReleaseVersion\`](#amazoncdkawsekscfnnodegrouppropspropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`RemoteAccess\`](#amazoncdkawsekscfnnodegrouppropspropertyremoteaccess) | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`ScalingConfig\`](#amazoncdkawsekscfnnodegrouppropspropertyscalingconfig) | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`Tags\`](#amazoncdkawsekscfnnodegrouppropspropertytags) | \`object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`Taints\`](#amazoncdkawsekscfnnodegrouppropspropertytaints) | object | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouppropspropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| ClusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| NodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| Subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| AmiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| CapacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| DiskSize | double | \`AWS::EKS::Nodegroup.DiskSize\`. | +| ForceUpdateEnabled | object | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| InstanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| Labels | object | \`AWS::EKS::Nodegroup.Labels\`. | +| LaunchTemplate | object | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| NodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| ReleaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| RemoteAccess | object | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| ScalingConfig | object | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| Tags | object | \`AWS::EKS::Nodegroup.Tags\`. | +| Taints | object | \`AWS::EKS::Nodegroup.Taints\`. | +| Version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -20148,13 +20272,13 @@ public string ClusterName { get; set; } --- -##### \`NodeRole\`Required +##### \`NodeRole\`Required \`\`\`csharp public string NodeRole { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -20162,13 +20286,13 @@ public string NodeRole { get; set; } --- -##### \`Subnets\`Required +##### \`Subnets\`Required \`\`\`csharp public string[] Subnets { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -20176,13 +20300,13 @@ public string[] Subnets { get; set; } --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public string AmiType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -20190,13 +20314,13 @@ public string AmiType { get; set; } --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public string CapacityType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -20204,13 +20328,13 @@ public string CapacityType { get; set; } --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`AWS::EKS::Nodegroup.DiskSize\`. @@ -20218,7 +20342,7 @@ public double DiskSize { get; set; } --- -##### \`ForceUpdateEnabled\`Optional +##### \`ForceUpdateEnabled\`Optional \`\`\`csharp public object ForceUpdateEnabled { get; set; } @@ -20232,13 +20356,13 @@ public object ForceUpdateEnabled { get; set; } --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public string[] InstanceTypes { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -20246,13 +20370,13 @@ public string[] InstanceTypes { get; set; } --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public object Labels { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Labels\`. @@ -20260,7 +20384,7 @@ public object Labels { get; set; } --- -##### \`LaunchTemplate\`Optional +##### \`LaunchTemplate\`Optional \`\`\`csharp public object LaunchTemplate { get; set; } @@ -20274,13 +20398,13 @@ public object LaunchTemplate { get; set; } --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -20288,13 +20412,13 @@ public string NodegroupName { get; set; } --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -20302,7 +20426,7 @@ public string ReleaseVersion { get; set; } --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public object RemoteAccess { get; set; } @@ -20316,7 +20440,7 @@ public object RemoteAccess { get; set; } --- -##### \`ScalingConfig\`Optional +##### \`ScalingConfig\`Optional \`\`\`csharp public object ScalingConfig { get; set; } @@ -20330,13 +20454,13 @@ public object ScalingConfig { get; set; } --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public object Tags { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::EKS::Nodegroup.Tags\`. @@ -20344,7 +20468,7 @@ public object Tags { get; set; } --- -##### \`Taints\`Optional +##### \`Taints\`Optional \`\`\`csharp public object Taints { get; set; } @@ -20358,13 +20482,13 @@ public object Taints { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -20372,11 +20496,11 @@ public string Version { get; set; } --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -20400,112 +20524,112 @@ new ClusterAttributes { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ClusterName\`](#amazoncdkawseksclusterattributespropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksclusterattributespropertyclustercertificateauthoritydata) | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksclusterattributespropertyclusterendpoint) | \`string\` | The API Server endpoint URL. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksclusterattributespropertyclustersecuritygroupid) | \`string\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterattributespropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterattributespropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterattributespropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`KubectlPrivateSubnetIds\`](#amazoncdkawseksclusterattributespropertykubectlprivatesubnetids) | \`string\`[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRoleArn\`](#amazoncdkawseksclusterattributespropertykubectlrolearn) | \`string\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`KubectlSecurityGroupId\`](#amazoncdkawseksclusterattributespropertykubectlsecuritygroupid) | \`string\` | A security group to use for \`kubectl\` execution. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksclusterattributespropertyopenidconnectprovider) | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`Prune\`](#amazoncdkawseksclusterattributespropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecurityGroupIds\`](#amazoncdkawseksclusterattributespropertysecuritygroupids) | \`string\`[] | Additional security groups associated with this cluster. | -| [\`Vpc\`](#amazoncdkawseksclusterattributespropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | +| ClusterName | string | The physical name of the Cluster. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The API Server endpoint URL. | +| ClusterSecurityGroupId | string | The cluster security group that was created by Amazon EKS for the cluster. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables to use when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| KubectlPrivateSubnetIds | string[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRoleArn | string | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| KubectlSecurityGroupId | string | A security group to use for \`kubectl\` execution. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecurityGroupIds | string[] | Additional security groups associated with this cluster. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`ClusterCertificateAuthorityData\`Optional +##### \`ClusterCertificateAuthorityData\`Optional \`\`\`csharp public string ClusterCertificateAuthorityData { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Optional +##### \`ClusterEncryptionConfigKeyArn\`Optional \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Optional +##### \`ClusterEndpoint\`Optional \`\`\`csharp public string ClusterEndpoint { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`ClusterSecurityGroupId\`Optional +##### \`ClusterSecurityGroupId\`Optional \`\`\`csharp public string ClusterSecurityGroupId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -20514,26 +20638,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`KubectlPrivateSubnetIds\`Optional +##### \`KubectlPrivateSubnetIds\`Optional \`\`\`csharp public string[] KubectlPrivateSubnetIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -20542,26 +20666,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`KubectlRoleArn\`Optional +##### \`KubectlRoleArn\`Optional \`\`\`csharp public string KubectlRoleArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`KubectlSecurityGroupId\`Optional +##### \`KubectlSecurityGroupId\`Optional \`\`\`csharp public string KubectlSecurityGroupId { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -20570,13 +20694,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`OpenIdConnectProvider\`Optional +##### \`OpenIdConnectProvider\`Optional \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -20585,13 +20709,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -20600,37 +20724,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecurityGroupIds\`Optional +##### \`SecurityGroupIds\`Optional \`\`\`csharp public string[] SecurityGroupIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -20658,77 +20782,77 @@ new ClusterOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksclusteroptionspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksclusteroptionspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksclusteroptionspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksclusteroptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksclusteroptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksclusteroptionspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksclusteroptionspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksclusteroptionspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusteroptionspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksclusteroptionspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusteroptionspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksclusteroptionspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksclusteroptionspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksclusteroptionspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksclusteroptionspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -20737,52 +20861,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -20791,54 +20915,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -20847,84 +20971,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -20933,24 +21057,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -20981,80 +21105,80 @@ new ClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksclusterpropspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksclusterpropspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksclusterpropspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksclusterpropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksclusterpropspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksclusterpropspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksclusterpropspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksclusterpropspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksclusterpropspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksclusterpropspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksclusterpropspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksclusterpropspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksclusterpropspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`DefaultCapacity\`](#amazoncdkawseksclusterpropspropertydefaultcapacity) | \`double\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`DefaultCapacityInstance\`](#amazoncdkawseksclusterpropspropertydefaultcapacityinstance) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`DefaultCapacityType\`](#amazoncdkawseksclusterpropspropertydefaultcapacitytype) | [\`Amazon.CDK.aws_eks.DefaultCapacityType\`](#Amazon.CDK.aws_eks.DefaultCapacityType) | The default capacity type for the cluster. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| DefaultCapacity | double | Number of instances to allocate as an initial capacity for this cluster. | +| DefaultCapacityInstance | Amazon.CDK.aws_ec2.InstanceType | The instance type to use for the default capacity. | +| DefaultCapacityType | Amazon.CDK.aws_eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -21063,52 +21187,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -21117,54 +21241,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -21173,84 +21297,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -21259,26 +21383,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`DefaultCapacity\`Optional +##### \`DefaultCapacity\`Optional \`\`\`csharp public double DefaultCapacity { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -21287,13 +21411,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`DefaultCapacityInstance\`Optional +##### \`DefaultCapacityInstance\`Optional \`\`\`csharp public InstanceType DefaultCapacityInstance { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -21302,24 +21426,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`DefaultCapacityType\`Optional +##### \`DefaultCapacityType\`Optional \`\`\`csharp public DefaultCapacityType DefaultCapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.DefaultCapacityType\`](#Amazon.CDK.aws_eks.DefaultCapacityType) +- *Type:* Amazon.CDK.aws_eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -21336,66 +21460,66 @@ new CommonClusterOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawsekscommonclusteroptionspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawsekscommonclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawsekscommonclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawsekscommonclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawsekscommonclusteroptionspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawsekscommonclusteroptionspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawsekscommonclusteroptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawsekscommonclusteroptionspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -21404,52 +21528,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -21458,11 +21582,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -21474,60 +21598,60 @@ new EksOptimizedImageProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CpuArch\`](#amazoncdkawsekseksoptimizedimagepropspropertycpuarch) | [\`Amazon.CDK.aws_eks.CpuArch\`](#Amazon.CDK.aws_eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`KubernetesVersion\`](#amazoncdkawsekseksoptimizedimagepropspropertykubernetesversion) | \`string\` | The Kubernetes version to use. | -| [\`NodeType\`](#amazoncdkawsekseksoptimizedimagepropspropertynodetype) | [\`Amazon.CDK.aws_eks.NodeType\`](#Amazon.CDK.aws_eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| CpuArch | Amazon.CDK.aws_eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| KubernetesVersion | string | The Kubernetes version to use. | +| NodeType | Amazon.CDK.aws_eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`CpuArch\`Optional +##### \`CpuArch\`Optional \`\`\`csharp public CpuArch CpuArch { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CpuArch\`](#Amazon.CDK.aws_eks.CpuArch) +- *Type:* Amazon.CDK.aws_eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`KubernetesVersion\`Optional +##### \`KubernetesVersion\`Optional \`\`\`csharp public string KubernetesVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest version The Kubernetes version to use. --- -##### \`NodeType\`Optional +##### \`NodeType\`Optional \`\`\`csharp public NodeType NodeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodeType\`](#Amazon.CDK.aws_eks.NodeType) +- *Type:* Amazon.CDK.aws_eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -21538,16 +21662,16 @@ new EncryptionConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Provider\`](#amazoncdkawsekscfnclusterencryptionconfigpropertypropertyprovider) | object | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`Resources\`](#amazoncdkawsekscfnclusterencryptionconfigpropertypropertyresources) | \`string\`[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| Provider | object | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| Resources | string[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`Provider\`Optional +##### \`Provider\`Optional \`\`\`csharp public object Provider { get; set; } @@ -21561,13 +21685,13 @@ public object Provider { get; set; } --- -##### \`Resources\`Optional +##### \`Resources\`Optional \`\`\`csharp public string[] Resources { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -21575,11 +21699,11 @@ public string[] Resources { get; set; } --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -21608,78 +21732,78 @@ new FargateClusterProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawseksfargateclusterpropspropertyversion)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`ClusterName\`](#amazoncdkawseksfargateclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`OutputClusterName\`](#amazoncdkawseksfargateclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`OutputConfigCommand\`](#amazoncdkawseksfargateclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`Role\`](#amazoncdkawseksfargateclusterpropspropertyrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`SecurityGroup\`](#amazoncdkawseksfargateclusterpropspropertysecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`Vpc\`](#amazoncdkawseksfargateclusterpropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`VpcSubnets\`](#amazoncdkawseksfargateclusterpropspropertyvpcsubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`ClusterHandlerEnvironment\`](#amazoncdkawseksfargateclusterpropspropertyclusterhandlerenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`CoreDnsComputeType\`](#amazoncdkawseksfargateclusterpropspropertycorednscomputetype) | [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`EndpointAccess\`](#amazoncdkawseksfargateclusterpropspropertyendpointaccess) | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`KubectlEnvironment\`](#amazoncdkawseksfargateclusterpropspropertykubectlenvironment) | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | -| [\`KubectlLayer\`](#amazoncdkawseksfargateclusterpropspropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksfargateclusterpropspropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`MastersRole\`](#amazoncdkawseksfargateclusterpropspropertymastersrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`OutputMastersRoleArn\`](#amazoncdkawseksfargateclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`PlaceClusterHandlerInVpc\`](#amazoncdkawseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`Prune\`](#amazoncdkawseksfargateclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`SecretsEncryptionKey\`](#amazoncdkawseksfargateclusterpropspropertysecretsencryptionkey) | [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`DefaultProfile\`](#amazoncdkawseksfargateclusterpropspropertydefaultprofile) | [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| Version | Amazon.CDK.aws_eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| ClusterName | string | Name for the cluster. | +| OutputClusterName | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| OutputConfigCommand | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| Role | Amazon.CDK.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| SecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| VpcSubnets | Amazon.CDK.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| ClusterHandlerEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| CoreDnsComputeType | Amazon.CDK.aws_eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| EndpointAccess | Amazon.CDK.aws_eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Environment variables for the kubectl execution. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| MastersRole | Amazon.CDK.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| OutputMastersRoleArn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| PlaceClusterHandlerInVpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| Prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| SecretsEncryptionKey | Amazon.CDK.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| DefaultProfile | Amazon.CDK.aws_eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public KubernetesVersion Version { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`ClusterName\`Optional +##### \`ClusterName\`Optional \`\`\`csharp public string ClusterName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`OutputClusterName\`Optional +##### \`OutputClusterName\`Optional \`\`\`csharp public bool OutputClusterName { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`OutputConfigCommand\`Optional +##### \`OutputConfigCommand\`Optional \`\`\`csharp public bool OutputConfigCommand { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -21688,52 +21812,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`Role\`Optional +##### \`Role\`Optional \`\`\`csharp public IRole Role { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`SecurityGroup\`Optional +##### \`SecurityGroup\`Optional \`\`\`csharp public ISecurityGroup SecurityGroup { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`VpcSubnets\`Optional +##### \`VpcSubnets\`Optional \`\`\`csharp public SubnetSelection[] VpcSubnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection)[] +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -21742,54 +21866,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`ClusterHandlerEnvironment\`Optional +##### \`ClusterHandlerEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary ClusterHandlerEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`CoreDnsComputeType\`Optional +##### \`CoreDnsComputeType\`Optional \`\`\`csharp public CoreDnsComputeType CoreDnsComputeType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CoreDnsComputeType\`](#Amazon.CDK.aws_eks.CoreDnsComputeType) +- *Type:* Amazon.CDK.aws_eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`EndpointAccess\`Optional +##### \`EndpointAccess\`Optional \`\`\`csharp public EndpointAccess EndpointAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -21798,84 +21922,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`csharp // Example automatically generated from non-compiling source. May contain errors. var layer = new lambda.LayerVersion(this, \\"kubectl-layer\\", new Struct { Code = lambda.Code.FromAsset($\\"{__dirname}/layer.zip\\") });[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`MastersRole\`Optional +##### \`MastersRole\`Optional \`\`\`csharp public IRole MastersRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`OutputMastersRoleArn\`Optional +##### \`OutputMastersRoleArn\`Optional \`\`\`csharp public bool OutputMastersRoleArn { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`PlaceClusterHandlerInVpc\`Optional +##### \`PlaceClusterHandlerInVpc\`Optional \`\`\`csharp public bool PlaceClusterHandlerInVpc { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -21884,37 +22008,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`SecretsEncryptionKey\`Optional +##### \`SecretsEncryptionKey\`Optional \`\`\`csharp public IKey SecretsEncryptionKey { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_kms.IKey\`](#Amazon.CDK.aws_kms.IKey) +- *Type:* Amazon.CDK.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`DefaultProfile\`Optional +##### \`DefaultProfile\`Optional \`\`\`csharp public FargateProfileOptions DefaultProfile { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.FargateProfileOptions\`](#Amazon.CDK.aws_eks.FargateProfileOptions) +- *Type:* Amazon.CDK.aws_eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -21928,25 +22052,25 @@ new FargateProfileOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Selectors\`](#amazoncdkawseksfargateprofileoptionspropertyselectors)* | [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofileoptionspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofileoptionspropertypodexecutionrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`SubnetSelection\`](#amazoncdkawseksfargateprofileoptionspropertysubnetselection) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`Vpc\`](#amazoncdkawseksfargateprofileoptionspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| Selectors | Amazon.CDK.aws_eks.Selector[] | The selectors to match for pods to use this Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| SubnetSelection | Amazon.CDK.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public Selector[] Selectors { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] +- *Type:* Amazon.CDK.aws_eks.Selector[] The selectors to match for pods to use this Fargate profile. @@ -21954,43 +22078,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`PodExecutionRole\`Optional +##### \`PodExecutionRole\`Optional \`\`\`csharp public IRole PodExecutionRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`SubnetSelection\`Optional +##### \`SubnetSelection\`Optional \`\`\`csharp public SubnetSelection SubnetSelection { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -21999,13 +22123,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -22014,11 +22138,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22033,26 +22157,26 @@ new FargateProfileProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Selectors\`](#amazoncdkawseksfargateprofilepropspropertyselectors)* | [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`FargateProfileName\`](#amazoncdkawseksfargateprofilepropspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`PodExecutionRole\`](#amazoncdkawseksfargateprofilepropspropertypodexecutionrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`SubnetSelection\`](#amazoncdkawseksfargateprofilepropspropertysubnetselection) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`Vpc\`](#amazoncdkawseksfargateprofilepropspropertyvpc) | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`Cluster\`](#amazoncdkawseksfargateprofilepropspropertycluster)* | [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| Selectors | Amazon.CDK.aws_eks.Selector[] | The selectors to match for pods to use this Fargate profile. | +| FargateProfileName | string | The name of the Fargate profile. | +| PodExecutionRole | Amazon.CDK.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| SubnetSelection | Amazon.CDK.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| Cluster | Amazon.CDK.aws_eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`Selectors\`Required +##### \`Selectors\`Required \`\`\`csharp public Selector[] Selectors { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Selector\`](#Amazon.CDK.aws_eks.Selector)[] +- *Type:* Amazon.CDK.aws_eks.Selector[] The selectors to match for pods to use this Fargate profile. @@ -22060,43 +22184,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`FargateProfileName\`Optional +##### \`FargateProfileName\`Optional \`\`\`csharp public string FargateProfileName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`PodExecutionRole\`Optional +##### \`PodExecutionRole\`Optional \`\`\`csharp public IRole PodExecutionRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`SubnetSelection\`Optional +##### \`SubnetSelection\`Optional \`\`\`csharp public SubnetSelection SubnetSelection { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -22105,13 +22229,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`Vpc\`Optional +##### \`Vpc\`Optional \`\`\`csharp public IVpc Vpc { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -22120,13 +22244,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public Cluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster) +- *Type:* Amazon.CDK.aws_eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -22134,11 +22258,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22156,80 +22280,80 @@ new HelmChartOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Chart\`](#amazoncdkawsekshelmchartoptionspropertychart)* | \`string\` | The name of the chart. | -| [\`CreateNamespace\`](#amazoncdkawsekshelmchartoptionspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`Namespace\`](#amazoncdkawsekshelmchartoptionspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`Release\`](#amazoncdkawsekshelmchartoptionspropertyrelease) | \`string\` | The name of the release. | -| [\`Repository\`](#amazoncdkawsekshelmchartoptionspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`Timeout\`](#amazoncdkawsekshelmchartoptionspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`Values\`](#amazoncdkawsekshelmchartoptionspropertyvalues) | System.Collections.Generic.IDictionary | The values to be used by the chart. | -| [\`Version\`](#amazoncdkawsekshelmchartoptionspropertyversion) | \`string\` | The chart version to install. | -| [\`Wait\`](#amazoncdkawsekshelmchartoptionspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| Chart | string | The name of the chart. | +| CreateNamespace | bool | create namespace if not exist. | +| Namespace | string | The Kubernetes namespace scope of the requests. | +| Release | string | The name of the release. | +| Repository | string | The repository which contains the chart. | +| Timeout | Amazon.CDK.Duration | Amount of time to wait for any individual Kubernetes operation. | +| Values | System.Collections.Generic.IDictionary | The values to be used by the chart. | +| Version | string | The chart version to install. | +| Wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`Chart\`Required +##### \`Chart\`Required \`\`\`csharp public string Chart { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`CreateNamespace\`Optional +##### \`CreateNamespace\`Optional \`\`\`csharp public bool CreateNamespace { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`Release\`Optional +##### \`Release\`Optional \`\`\`csharp public string Release { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`Repository\`Optional +##### \`Repository\`Optional \`\`\`csharp public string Repository { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -22238,13 +22362,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -22253,50 +22377,50 @@ Maximum 15 minutes. --- -##### \`Values\`Optional +##### \`Values\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Values { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`Wait\`Optional +##### \`Wait\`Optional \`\`\`csharp public bool Wait { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22315,81 +22439,81 @@ new HelmChartProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Chart\`](#amazoncdkawsekshelmchartpropspropertychart)* | \`string\` | The name of the chart. | -| [\`CreateNamespace\`](#amazoncdkawsekshelmchartpropspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`Namespace\`](#amazoncdkawsekshelmchartpropspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`Release\`](#amazoncdkawsekshelmchartpropspropertyrelease) | \`string\` | The name of the release. | -| [\`Repository\`](#amazoncdkawsekshelmchartpropspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`Timeout\`](#amazoncdkawsekshelmchartpropspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`Values\`](#amazoncdkawsekshelmchartpropspropertyvalues) | System.Collections.Generic.IDictionary | The values to be used by the chart. | -| [\`Version\`](#amazoncdkawsekshelmchartpropspropertyversion) | \`string\` | The chart version to install. | -| [\`Wait\`](#amazoncdkawsekshelmchartpropspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`Cluster\`](#amazoncdkawsekshelmchartpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to apply this configuration to. | +| Chart | string | The name of the chart. | +| CreateNamespace | bool | create namespace if not exist. | +| Namespace | string | The Kubernetes namespace scope of the requests. | +| Release | string | The name of the release. | +| Repository | string | The repository which contains the chart. | +| Timeout | Amazon.CDK.Duration | Amount of time to wait for any individual Kubernetes operation. | +| Values | System.Collections.Generic.IDictionary | The values to be used by the chart. | +| Version | string | The chart version to install. | +| Wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`Chart\`Required +##### \`Chart\`Required \`\`\`csharp public string Chart { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`CreateNamespace\`Optional +##### \`CreateNamespace\`Optional \`\`\`csharp public bool CreateNamespace { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`Release\`Optional +##### \`Release\`Optional \`\`\`csharp public string Release { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`Repository\`Optional +##### \`Repository\`Optional \`\`\`csharp public string Repository { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -22398,13 +22522,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -22413,52 +22537,52 @@ Maximum 15 minutes. --- -##### \`Values\`Optional +##### \`Values\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Values { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`Wait\`Optional +##### \`Wait\`Optional \`\`\`csharp public bool Wait { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to apply this configuration to. @@ -22466,11 +22590,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22481,50 +22605,50 @@ new KubernetesManifestOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Prune\`](#amazoncdkawsekskubernetesmanifestoptionspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`SkipValidation\`](#amazoncdkawsekskubernetesmanifestoptionspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | +| Prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| SkipValidation | bool | A flag to signify if the manifest validation should be skipped. | --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`SkipValidation\`Optional +##### \`SkipValidation\`Optional \`\`\`csharp public bool SkipValidation { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22538,55 +22662,55 @@ new KubernetesManifestProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Prune\`](#amazoncdkawsekskubernetesmanifestpropspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`SkipValidation\`](#amazoncdkawsekskubernetesmanifestpropspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | -| [\`Cluster\`](#amazoncdkawsekskubernetesmanifestpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`Manifest\`](#amazoncdkawsekskubernetesmanifestpropspropertymanifest)* | System.Collections.Generic.IDictionary[] | The manifest to apply. | -| [\`Overwrite\`](#amazoncdkawsekskubernetesmanifestpropspropertyoverwrite) | \`bool\` | Overwrite any existing resources. | +| Prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| SkipValidation | bool | A flag to signify if the manifest validation should be skipped. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to apply this manifest to. | +| Manifest | System.Collections.Generic.IDictionary[] | The manifest to apply. | +| Overwrite | bool | Overwrite any existing resources. | --- -##### \`Prune\`Optional +##### \`Prune\`Optional \`\`\`csharp public bool Prune { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`SkipValidation\`Optional +##### \`SkipValidation\`Optional \`\`\`csharp public bool SkipValidation { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to apply this manifest to. @@ -22594,13 +22718,13 @@ The EKS cluster to apply this manifest to. --- -##### \`Manifest\`Required +##### \`Manifest\`Required \`\`\`csharp public System.Collections.Generic.IDictionary[] Manifest { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary[] +- *Type:* System.Collections.Generic.IDictionary[] The manifest to apply. @@ -22608,13 +22732,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`Overwrite\`Optional +##### \`Overwrite\`Optional \`\`\`csharp public bool Overwrite { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Overwrite any existing resources. @@ -22623,11 +22747,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22637,21 +22761,21 @@ new KubernetesNetworkConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ServiceIpv4Cidr\`](#amazoncdkawsekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`string\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| ServiceIpv4Cidr | string | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`ServiceIpv4Cidr\`Optional +##### \`ServiceIpv4Cidr\`Optional \`\`\`csharp public string ServiceIpv4Cidr { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -22659,11 +22783,11 @@ public string ServiceIpv4Cidr { get; set; } --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22678,26 +22802,26 @@ new KubernetesObjectValueProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Cluster\`](#amazoncdkawsekskubernetesobjectvaluepropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`JsonPath\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyjsonpath)* | \`string\` | JSONPath to the specific value. | -| [\`ObjectName\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjectname)* | \`string\` | The name of the object to query. | -| [\`ObjectType\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjecttype)* | \`string\` | The object type to query. | -| [\`ObjectNamespace\`](#amazoncdkawsekskubernetesobjectvaluepropspropertyobjectnamespace) | \`string\` | The namespace the object belongs to. | -| [\`Timeout\`](#amazoncdkawsekskubernetesobjectvaluepropspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Timeout for waiting on a value. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The EKS cluster to fetch attributes from. | +| JsonPath | string | JSONPath to the specific value. | +| ObjectName | string | The name of the object to query. | +| ObjectType | string | The object type to query. | +| ObjectNamespace | string | The namespace the object belongs to. | +| Timeout | Amazon.CDK.Duration | Timeout for waiting on a value. | --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The EKS cluster to fetch attributes from. @@ -22705,39 +22829,39 @@ The EKS cluster to fetch attributes from. --- -##### \`JsonPath\`Required +##### \`JsonPath\`Required \`\`\`csharp public string JsonPath { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`ObjectName\`Required +##### \`ObjectName\`Required \`\`\`csharp public string ObjectName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the object to query. --- -##### \`ObjectType\`Required +##### \`ObjectType\`Required \`\`\`csharp public string ObjectType { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The object type to query. @@ -22745,37 +22869,37 @@ The object type to query. --- -##### \`ObjectNamespace\`Optional +##### \`ObjectNamespace\`Optional \`\`\`csharp public string ObjectNamespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the object belongs to. --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22790,38 +22914,38 @@ new KubernetesPatchProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ApplyPatch\`](#amazoncdkawsekskubernetespatchpropspropertyapplypatch)* | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`Cluster\`](#amazoncdkawsekskubernetespatchpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The cluster to apply the patch to. | -| [\`ResourceName\`](#amazoncdkawsekskubernetespatchpropspropertyresourcename)* | \`string\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`RestorePatch\`](#amazoncdkawsekskubernetespatchpropspropertyrestorepatch)* | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`PatchType\`](#amazoncdkawsekskubernetespatchpropspropertypatchtype) | [\`Amazon.CDK.aws_eks.PatchType\`](#Amazon.CDK.aws_eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`ResourceNamespace\`](#amazoncdkawsekskubernetespatchpropspropertyresourcenamespace) | \`string\` | The kubernetes API namespace. | +| ApplyPatch | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The cluster to apply the patch to. | +| ResourceName | string | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| RestorePatch | System.Collections.Generic.IDictionary | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| PatchType | Amazon.CDK.aws_eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| ResourceNamespace | string | The kubernetes API namespace. | --- -##### \`ApplyPatch\`Required +##### \`ApplyPatch\`Required \`\`\`csharp public System.Collections.Generic.IDictionary ApplyPatch { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The cluster to apply the patch to. @@ -22829,37 +22953,37 @@ The cluster to apply the patch to. --- -##### \`ResourceName\`Required +##### \`ResourceName\`Required \`\`\`csharp public string ResourceName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`RestorePatch\`Required +##### \`RestorePatch\`Required \`\`\`csharp public System.Collections.Generic.IDictionary RestorePatch { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`PatchType\`Optional +##### \`PatchType\`Optional \`\`\`csharp public PatchType PatchType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.PatchType\`](#Amazon.CDK.aws_eks.PatchType) +- *Type:* Amazon.CDK.aws_eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -22868,24 +22992,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`ResourceNamespace\`Optional +##### \`ResourceNamespace\`Optional \`\`\`csharp public string ResourceNamespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22896,22 +23020,22 @@ new LabelProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Key\`](#amazoncdkawsekscfnfargateprofilelabelpropertypropertykey)* | \`string\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`Value\`](#amazoncdkawsekscfnfargateprofilelabelpropertypropertyvalue)* | \`string\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| Key | string | \`CfnFargateProfile.LabelProperty.Key\`. | +| Value | string | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`Key\`Required +##### \`Key\`Required \`\`\`csharp public string Key { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Key\`. @@ -22919,13 +23043,13 @@ public string Key { get; set; } --- -##### \`Value\`Required +##### \`Value\`Required \`\`\`csharp public string Value { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Value\`. @@ -22933,11 +23057,11 @@ public string Value { get; set; } --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22948,45 +23072,45 @@ new LaunchTemplateSpec { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Id\`](#amazoncdkawsekslaunchtemplatespecpropertyid)* | \`string\` | The Launch template ID. | -| [\`Version\`](#amazoncdkawsekslaunchtemplatespecpropertyversion) | \`string\` | The launch template version to be used (optional). | +| Id | string | The Launch template ID. | +| Version | string | The launch template version to be used (optional). | --- -##### \`Id\`Required +##### \`Id\`Required \`\`\`csharp public string Id { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Launch template ID. --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -22998,23 +23122,23 @@ new LaunchTemplateSpecificationProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Id\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`Name\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`Version\`](#amazoncdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| Id | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| Name | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| Version | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`Id\`Optional +##### \`Id\`Optional \`\`\`csharp public string Id { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -23022,13 +23146,13 @@ public string Id { get; set; } --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -23036,13 +23160,13 @@ public string Name { get; set; } --- -##### \`Version\`Optional +##### \`Version\`Optional \`\`\`csharp public string Version { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -23050,11 +23174,11 @@ public string Version { get; set; } --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23080,63 +23204,63 @@ new NodegroupOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AmiType\`](#amazoncdkawseksnodegroupoptionspropertyamitype) | [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`CapacityType\`](#amazoncdkawseksnodegroupoptionspropertycapacitytype) | [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`DesiredSize\`](#amazoncdkawseksnodegroupoptionspropertydesiredsize) | \`double\` | The current number of worker nodes that the managed node group should maintain. | -| [\`DiskSize\`](#amazoncdkawseksnodegroupoptionspropertydisksize) | \`double\` | The root device disk size (in GiB) for your node group instances. | -| [\`ForceUpdate\`](#amazoncdkawseksnodegroupoptionspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`InstanceType\`](#amazoncdkawseksnodegroupoptionspropertyinstancetype) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | The instance type to use for your node group. | -| [\`InstanceTypes\`](#amazoncdkawseksnodegroupoptionspropertyinstancetypes) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`Labels\`](#amazoncdkawseksnodegroupoptionspropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`LaunchTemplateSpec\`](#amazoncdkawseksnodegroupoptionspropertylaunchtemplatespec) | [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`MaxSize\`](#amazoncdkawseksnodegroupoptionspropertymaxsize) | \`double\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`MinSize\`](#amazoncdkawseksnodegroupoptionspropertyminsize) | \`double\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`NodegroupName\`](#amazoncdkawseksnodegroupoptionspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`NodeRole\`](#amazoncdkawseksnodegroupoptionspropertynoderole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`ReleaseVersion\`](#amazoncdkawseksnodegroupoptionspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`RemoteAccess\`](#amazoncdkawseksnodegroupoptionspropertyremoteaccess) | [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`Subnets\`](#amazoncdkawseksnodegroupoptionspropertysubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`Tags\`](#amazoncdkawseksnodegroupoptionspropertytags) | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | +| AmiType | Amazon.CDK.aws_eks.NodegroupAmiType | The AMI type for your node group. | +| CapacityType | Amazon.CDK.aws_eks.CapacityType | The capacity type of the nodegroup. | +| DesiredSize | double | The current number of worker nodes that the managed node group should maintain. | +| DiskSize | double | The root device disk size (in GiB) for your node group instances. | +| ForceUpdate | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| InstanceType | Amazon.CDK.aws_ec2.InstanceType | The instance type to use for your node group. | +| InstanceTypes | Amazon.CDK.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| LaunchTemplateSpec | Amazon.CDK.aws_eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| MaxSize | double | The maximum number of worker nodes that the managed node group can scale out to. | +| MinSize | double | The minimum number of worker nodes that the managed node group can scale in to. | +| NodegroupName | string | Name of the Nodegroup. | +| NodeRole | Amazon.CDK.aws_iam.IRole | The IAM role to associate with your node group. | +| ReleaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| RemoteAccess | Amazon.CDK.aws_eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| Subnets | Amazon.CDK.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| Tags | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public NodegroupAmiType AmiType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) +- *Type:* Amazon.CDK.aws_eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public CapacityType CapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) +- *Type:* Amazon.CDK.aws_eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -23145,26 +23269,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`ForceUpdate\`Optional +##### \`ForceUpdate\`Optional \`\`\`csharp public bool ForceUpdate { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -23173,7 +23297,7 @@ If an update fails because pods could not be drained, you can force the update a --- -##### ~~\`InstanceType\`~~Optional +##### ~~\`InstanceType\`~~Optional - *Deprecated:* Use \`instanceTypes\` instead. @@ -23181,7 +23305,7 @@ If an update fails because pods could not be drained, you can force the update a public InstanceType InstanceType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType - *Default:* t3.medium The instance type to use for your node group. @@ -23190,56 +23314,56 @@ Currently, you can specify a single instance type for a node group. The default --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public InstanceType[] InstanceTypes { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] +- *Type:* Amazon.CDK.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`LaunchTemplateSpec\`Optional +##### \`LaunchTemplateSpec\`Optional \`\`\`csharp public LaunchTemplateSpec LaunchTemplateSpec { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) +- *Type:* Amazon.CDK.aws_eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -23248,13 +23372,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -23263,26 +23387,26 @@ This number must be greater than zero. --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`NodeRole\`Optional +##### \`NodeRole\`Optional \`\`\`csharp public IRole NodeRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -23291,26 +23415,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public NodegroupRemoteAccess RemoteAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) +- *Type:* Amazon.CDK.aws_eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -23319,13 +23443,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public SubnetSelection Subnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -23334,13 +23458,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Tags { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -23349,11 +23473,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23380,64 +23504,64 @@ new NodegroupProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`AmiType\`](#amazoncdkawseksnodegrouppropspropertyamitype) | [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`CapacityType\`](#amazoncdkawseksnodegrouppropspropertycapacitytype) | [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`DesiredSize\`](#amazoncdkawseksnodegrouppropspropertydesiredsize) | \`double\` | The current number of worker nodes that the managed node group should maintain. | -| [\`DiskSize\`](#amazoncdkawseksnodegrouppropspropertydisksize) | \`double\` | The root device disk size (in GiB) for your node group instances. | -| [\`ForceUpdate\`](#amazoncdkawseksnodegrouppropspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`InstanceType\`](#amazoncdkawseksnodegrouppropspropertyinstancetype) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) | The instance type to use for your node group. | -| [\`InstanceTypes\`](#amazoncdkawseksnodegrouppropspropertyinstancetypes) | [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`Labels\`](#amazoncdkawseksnodegrouppropspropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`LaunchTemplateSpec\`](#amazoncdkawseksnodegrouppropspropertylaunchtemplatespec) | [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`MaxSize\`](#amazoncdkawseksnodegrouppropspropertymaxsize) | \`double\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`MinSize\`](#amazoncdkawseksnodegrouppropspropertyminsize) | \`double\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`NodegroupName\`](#amazoncdkawseksnodegrouppropspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`NodeRole\`](#amazoncdkawseksnodegrouppropspropertynoderole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`ReleaseVersion\`](#amazoncdkawseksnodegrouppropspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`RemoteAccess\`](#amazoncdkawseksnodegrouppropspropertyremoteaccess) | [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`Subnets\`](#amazoncdkawseksnodegrouppropspropertysubnets) | [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`Tags\`](#amazoncdkawseksnodegrouppropspropertytags) | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | -| [\`Cluster\`](#amazoncdkawseksnodegrouppropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | Cluster resource. | +| AmiType | Amazon.CDK.aws_eks.NodegroupAmiType | The AMI type for your node group. | +| CapacityType | Amazon.CDK.aws_eks.CapacityType | The capacity type of the nodegroup. | +| DesiredSize | double | The current number of worker nodes that the managed node group should maintain. | +| DiskSize | double | The root device disk size (in GiB) for your node group instances. | +| ForceUpdate | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| InstanceType | Amazon.CDK.aws_ec2.InstanceType | The instance type to use for your node group. | +| InstanceTypes | Amazon.CDK.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| LaunchTemplateSpec | Amazon.CDK.aws_eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| MaxSize | double | The maximum number of worker nodes that the managed node group can scale out to. | +| MinSize | double | The minimum number of worker nodes that the managed node group can scale in to. | +| NodegroupName | string | Name of the Nodegroup. | +| NodeRole | Amazon.CDK.aws_iam.IRole | The IAM role to associate with your node group. | +| ReleaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| RemoteAccess | Amazon.CDK.aws_eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| Subnets | Amazon.CDK.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| Tags | System.Collections.Generic.IDictionary | The metadata to apply to the node group to assist with categorization and organization. | +| Cluster | Amazon.CDK.aws_eks.ICluster | Cluster resource. | --- -##### \`AmiType\`Optional +##### \`AmiType\`Optional \`\`\`csharp public NodegroupAmiType AmiType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupAmiType\`](#Amazon.CDK.aws_eks.NodegroupAmiType) +- *Type:* Amazon.CDK.aws_eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`CapacityType\`Optional +##### \`CapacityType\`Optional \`\`\`csharp public CapacityType CapacityType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.CapacityType\`](#Amazon.CDK.aws_eks.CapacityType) +- *Type:* Amazon.CDK.aws_eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -23446,26 +23570,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`DiskSize\`Optional +##### \`DiskSize\`Optional \`\`\`csharp public double DiskSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`ForceUpdate\`Optional +##### \`ForceUpdate\`Optional \`\`\`csharp public bool ForceUpdate { get; set; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -23474,7 +23598,7 @@ If an update fails because pods could not be drained, you can force the update a --- -##### ~~\`InstanceType\`~~Optional +##### ~~\`InstanceType\`~~Optional - *Deprecated:* Use \`instanceTypes\` instead. @@ -23482,7 +23606,7 @@ If an update fails because pods could not be drained, you can force the update a public InstanceType InstanceType { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType) +- *Type:* Amazon.CDK.aws_ec2.InstanceType - *Default:* t3.medium The instance type to use for your node group. @@ -23491,56 +23615,56 @@ Currently, you can specify a single instance type for a node group. The default --- -##### \`InstanceTypes\`Optional +##### \`InstanceTypes\`Optional \`\`\`csharp public InstanceType[] InstanceTypes { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.InstanceType\`](#Amazon.CDK.aws_ec2.InstanceType)[] +- *Type:* Amazon.CDK.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`LaunchTemplateSpec\`Optional +##### \`LaunchTemplateSpec\`Optional \`\`\`csharp public LaunchTemplateSpec LaunchTemplateSpec { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.LaunchTemplateSpec\`](#Amazon.CDK.aws_eks.LaunchTemplateSpec) +- *Type:* Amazon.CDK.aws_eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -23549,13 +23673,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -23564,26 +23688,26 @@ This number must be greater than zero. --- -##### \`NodegroupName\`Optional +##### \`NodegroupName\`Optional \`\`\`csharp public string NodegroupName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`NodeRole\`Optional +##### \`NodeRole\`Optional \`\`\`csharp public IRole NodeRole { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -23592,26 +23716,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`ReleaseVersion\`Optional +##### \`ReleaseVersion\`Optional \`\`\`csharp public string ReleaseVersion { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`RemoteAccess\`Optional +##### \`RemoteAccess\`Optional \`\`\`csharp public NodegroupRemoteAccess RemoteAccess { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.NodegroupRemoteAccess\`](#Amazon.CDK.aws_eks.NodegroupRemoteAccess) +- *Type:* Amazon.CDK.aws_eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -23620,13 +23744,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`Subnets\`Optional +##### \`Subnets\`Optional \`\`\`csharp public SubnetSelection Subnets { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.SubnetSelection\`](#Amazon.CDK.aws_ec2.SubnetSelection) +- *Type:* Amazon.CDK.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -23635,13 +23759,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`Tags\`Optional +##### \`Tags\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Tags { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -23650,25 +23774,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23679,34 +23803,34 @@ new NodegroupRemoteAccess { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`SshKeyName\`](#amazoncdkawseksnodegroupremoteaccesspropertysshkeyname)* | \`string\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`SourceSecurityGroups\`](#amazoncdkawseksnodegroupremoteaccesspropertysourcesecuritygroups) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup)[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| SshKeyName | string | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| SourceSecurityGroups | Amazon.CDK.aws_ec2.ISecurityGroup[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`SshKeyName\`Required +##### \`SshKeyName\`Required \`\`\`csharp public string SshKeyName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`SourceSecurityGroups\`Optional +##### \`SourceSecurityGroups\`Optional \`\`\`csharp public ISecurityGroup[] SourceSecurityGroups { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup)[] +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup[] - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -23715,11 +23839,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23729,21 +23853,21 @@ new OpenIdConnectProviderProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Url\`](#amazoncdkawseksopenidconnectproviderpropspropertyurl)* | \`string\` | The URL of the identity provider. | +| Url | string | The URL of the identity provider. | --- -##### \`Url\`Required +##### \`Url\`Required \`\`\`csharp public string Url { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URL of the identity provider. @@ -23751,11 +23875,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23765,21 +23889,21 @@ new ProviderProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`KeyArn\`](#amazoncdkawsekscfnclusterproviderpropertypropertykeyarn) | \`string\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| KeyArn | string | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`KeyArn\`Optional +##### \`KeyArn\`Optional \`\`\`csharp public string KeyArn { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.ProviderProperty.KeyArn\`. @@ -23787,11 +23911,11 @@ public string KeyArn { get; set; } --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23802,22 +23926,22 @@ new RemoteAccessProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Ec2SshKey\`](#amazoncdkawsekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`string\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`SourceSecurityGroups\`](#amazoncdkawsekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | \`string\`[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| Ec2SshKey | string | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| SourceSecurityGroups | string[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`Ec2SshKey\`Required +##### \`Ec2SshKey\`Required \`\`\`csharp public string Ec2SshKey { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -23825,13 +23949,13 @@ public string Ec2SshKey { get; set; } --- -##### \`SourceSecurityGroups\`Optional +##### \`SourceSecurityGroups\`Optional \`\`\`csharp public string[] SourceSecurityGroups { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -23839,11 +23963,11 @@ public string[] SourceSecurityGroups { get; set; } --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23854,22 +23978,22 @@ new ResourcesVpcConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`SubnetIds\`](#amazoncdkawsekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`SecurityGroupIds\`](#amazoncdkawsekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| SubnetIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| SecurityGroupIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`SubnetIds\`Required +##### \`SubnetIds\`Required \`\`\`csharp public string[] SubnetIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -23877,13 +24001,13 @@ public string[] SubnetIds { get; set; } --- -##### \`SecurityGroupIds\`Optional +##### \`SecurityGroupIds\`Optional \`\`\`csharp public string[] SecurityGroupIds { get; set; } \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -23891,11 +24015,11 @@ public string[] SecurityGroupIds { get; set; } --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23907,23 +24031,23 @@ new ScalingConfigProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`DesiredSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`MaxSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`MinSize\`](#amazoncdkawsekscfnnodegroupscalingconfigpropertypropertyminsize) | \`double\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| DesiredSize | double | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| MaxSize | double | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| MinSize | double | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`DesiredSize\`Optional +##### \`DesiredSize\`Optional \`\`\`csharp public double DesiredSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -23931,13 +24055,13 @@ public double DesiredSize { get; set; } --- -##### \`MaxSize\`Optional +##### \`MaxSize\`Optional \`\`\`csharp public double MaxSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -23945,13 +24069,13 @@ public double MaxSize { get; set; } --- -##### \`MinSize\`Optional +##### \`MinSize\`Optional \`\`\`csharp public double MinSize { get; set; } \`\`\` -- *Type:* \`double\` +- *Type:* double \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -23959,11 +24083,11 @@ public double MinSize { get; set; } --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -23974,22 +24098,22 @@ new Selector { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawseksselectorpropertynamespace)* | \`string\` | The Kubernetes namespace that the selector should match. | -| [\`Labels\`](#amazoncdkawseksselectorpropertylabels) | System.Collections.Generic.IDictionary | The Kubernetes labels that the selector should match. | +| Namespace | string | The Kubernetes namespace that the selector should match. | +| Labels | System.Collections.Generic.IDictionary | The Kubernetes labels that the selector should match. | --- -##### \`Namespace\`Required +##### \`Namespace\`Required \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string The Kubernetes namespace that the selector should match. @@ -23997,13 +24121,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary Labels { get; set; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -24012,11 +24136,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -24027,22 +24151,22 @@ new SelectorProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawsekscfnfargateprofileselectorpropertypropertynamespace)* | \`string\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`Labels\`](#amazoncdkawsekscfnfargateprofileselectorpropertypropertylabels) | object | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| Namespace | string | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| Labels | object | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`Namespace\`Required +##### \`Namespace\`Required \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -24050,7 +24174,7 @@ public string Namespace { get; set; } --- -##### \`Labels\`Optional +##### \`Labels\`Optional \`\`\`csharp public object Labels { get; set; } @@ -24064,11 +24188,11 @@ public object Labels { get; set; } --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -24079,46 +24203,46 @@ new ServiceAccountOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Name\`](#amazoncdkawseksserviceaccountoptionspropertyname) | \`string\` | The name of the service account. | -| [\`Namespace\`](#amazoncdkawseksserviceaccountoptionspropertynamespace) | \`string\` | The namespace of the service account. | +| Name | string | The name of the service account. | +| Namespace | string | The namespace of the service account. | --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -24130,59 +24254,59 @@ new ServiceAccountProps { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Name\`](#amazoncdkawseksserviceaccountpropspropertyname) | \`string\` | The name of the service account. | -| [\`Namespace\`](#amazoncdkawseksserviceaccountpropspropertynamespace) | \`string\` | The namespace of the service account. | -| [\`Cluster\`](#amazoncdkawseksserviceaccountpropspropertycluster)* | [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) | The cluster to apply the patch to. | +| Name | string | The name of the service account. | +| Namespace | string | The namespace of the service account. | +| Cluster | Amazon.CDK.aws_eks.ICluster | The cluster to apply the patch to. | --- -##### \`Name\`Optional +##### \`Name\`Optional \`\`\`csharp public string Name { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -##### \`Cluster\`Required +##### \`Cluster\`Required \`\`\`csharp public ICluster Cluster { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Type:* Amazon.CDK.aws_eks.ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -24193,46 +24317,46 @@ new ServiceLoadBalancerAddressOptions { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Namespace\`](#amazoncdkawseksserviceloadbalanceraddressoptionspropertynamespace) | \`string\` | The namespace the service belongs to. | -| [\`Timeout\`](#amazoncdkawseksserviceloadbalanceraddressoptionspropertytimeout) | [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) | Timeout for waiting on the load balancer address. | +| Namespace | string | The namespace the service belongs to. | +| Timeout | Amazon.CDK.Duration | Timeout for waiting on the load balancer address. | --- -##### \`Namespace\`Optional +##### \`Namespace\`Optional \`\`\`csharp public string Namespace { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the service belongs to. --- -##### \`Timeout\`Optional +##### \`Timeout\`Optional \`\`\`csharp public Duration Timeout { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.Duration\`](#Amazon.CDK.Duration) +- *Type:* Amazon.CDK.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`csharp using Amazon.CDK; @@ -24244,23 +24368,23 @@ new TaintProperty { }; \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Effect\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertyeffect) | \`string\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`Key\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertykey) | \`string\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`Value\`](#amazoncdkawsekscfnnodegrouptaintpropertypropertyvalue) | \`string\` | \`CfnNodegroup.TaintProperty.Value\`. | +| Effect | string | \`CfnNodegroup.TaintProperty.Effect\`. | +| Key | string | \`CfnNodegroup.TaintProperty.Key\`. | +| Value | string | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`Effect\`Optional +##### \`Effect\`Optional \`\`\`csharp public string Effect { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Effect\`. @@ -24268,13 +24392,13 @@ public string Effect { get; set; } --- -##### \`Key\`Optional +##### \`Key\`Optional \`\`\`csharp public string Key { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Key\`. @@ -24282,13 +24406,13 @@ public string Key { get; set; } --- -##### \`Value\`Optional +##### \`Value\`Optional \`\`\`csharp public string Value { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Value\`. @@ -24296,15 +24420,15 @@ public string Value { get; set; } --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`Amazon.CDK.aws_ec2.IMachineImage\`](#Amazon.CDK.aws_ec2.IMachineImage) +- *Implements:* Amazon.CDK.aws_ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`csharp using Amazon.CDK; @@ -24314,60 +24438,60 @@ new EksOptimizedImage(EksOptimizedImageProps Props = null); | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Props\`](#amazoncdkawsekseksoptimizedimageparameterprops) | [\`Amazon.CDK.aws_eks.EksOptimizedImageProps\`](#Amazon.CDK.aws_eks.EksOptimizedImageProps) | *No description.* | +| Props | Amazon.CDK.aws_eks.EksOptimizedImageProps | *No description.* | --- -##### \`Props\`Optional +##### \`Props\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.EksOptimizedImageProps\`](#Amazon.CDK.aws_eks.EksOptimizedImageProps) +- *Type:* Amazon.CDK.aws_eks.EksOptimizedImageProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`GetImage\`](#amazoncdkawsekseksoptimizedimagegetimage) | Return the correct image. | +| GetImage | Return the correct image. | --- -##### \`GetImage\` +##### \`GetImage\` \`\`\`csharp private GetImage(Construct Scope) \`\`\` -###### \`Scope\`Required +###### \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`OnlyFrom\`](#amazoncdkawseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| OnlyFrom | Restrict public access to specific CIDR blocks. | --- -##### \`OnlyFrom\` +##### \`OnlyFrom\` \`\`\`csharp private OnlyFrom(string Cidr) \`\`\` -###### \`Cidr\`Required +###### \`Cidr\`Required -- *Type:* \`string\` +- *Type:* string CIDR blocks. @@ -24375,19 +24499,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Private\`](#amazoncdkawseksendpointaccesspropertyprivate)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`Public\`](#amazoncdkawseksendpointaccesspropertypublic)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PublicAndPrivate\`](#amazoncdkawseksendpointaccesspropertypublicandprivate)* | [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| Private | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| Public | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PublicAndPrivate | Amazon.CDK.aws_eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`Private\` +##### \`Private\`Required -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +\`\`\`csharp +public EndpointAccess Private { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -24395,9 +24523,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`Public\` +##### \`Public\`Required + +\`\`\`csharp +public EndpointAccess Public { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -24405,9 +24537,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PublicAndPrivate\` +##### \`PublicAndPrivate\`Required + +\`\`\`csharp +public EndpointAccess PublicAndPrivate { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.EndpointAccess\`](#Amazon.CDK.aws_eks.EndpointAccess) +- *Type:* Amazon.CDK.aws_eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -24415,20 +24551,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`Of\`](#amazoncdkawsekskubernetesversionof) | Custom cluster version. | +| Of | Custom cluster version. | --- -##### \`Of\` +##### \`Of\` \`\`\`csharp using Amazon.CDK; @@ -24436,250 +24572,274 @@ using Amazon.CDK; KubernetesVersion.Of(string Version); \`\`\` -###### \`Version\`Required +###### \`Version\`Required -- *Type:* \`string\` +- *Type:* string custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Version\`](#amazoncdkawsekskubernetesversionpropertyversion)* | \`string\` | cluster version number. | +| Version | string | cluster version number. | --- -##### \`Version\`Required +##### \`Version\`Required \`\`\`csharp public string Version { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V114\`](#amazoncdkawsekskubernetesversionpropertyv114)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V115\`](#amazoncdkawsekskubernetesversionpropertyv115)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V116\`](#amazoncdkawsekskubernetesversionpropertyv116)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V117\`](#amazoncdkawsekskubernetesversionpropertyv117)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V118\`](#amazoncdkawsekskubernetesversionpropertyv118)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V119\`](#amazoncdkawsekskubernetesversionpropertyv119)* | [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) | Kubernetes version 1.19. | +| V114 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.14. | +| V115 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.15. | +| V116 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.16. | +| V117 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.17. | +| V118 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.18. | +| V119 | Amazon.CDK.aws_eks.KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V114\` +##### \`V114\`Required + +\`\`\`csharp +public KubernetesVersion V114 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.14. --- -##### \`V115\` +##### \`V115\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V115 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.15. --- -##### \`V116\` +##### \`V116\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V116 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.16. --- -##### \`V117\` +##### \`V117\`Required + +\`\`\`csharp +public KubernetesVersion V117 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.17. --- -##### \`V118\` +##### \`V118\`Required -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +\`\`\`csharp +public KubernetesVersion V118 { get; } +\`\`\` + +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.18. --- -##### \`V119\` +##### \`V119\`Required + +\`\`\`csharp +public KubernetesVersion V119 { get; } +\`\`\` -- *Type:* [\`Amazon.CDK.aws_eks.KubernetesVersion\`](#Amazon.CDK.aws_eks.KubernetesVersion) +- *Type:* Amazon.CDK.aws_eks.KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource), [\`Amazon.CDK.aws_ec2.IConnectable\`](#Amazon.CDK.aws_ec2.IConnectable) +- *Extends:* Amazon.CDK.IResource, Amazon.CDK.aws_ec2.IConnectable -- *Implemented By:* [\`Amazon.CDK.aws_eks.Cluster\`](#Amazon.CDK.aws_eks.Cluster), [\`Amazon.CDK.aws_eks.FargateCluster\`](#Amazon.CDK.aws_eks.FargateCluster), [\`Amazon.CDK.aws_eks.ICluster\`](#Amazon.CDK.aws_eks.ICluster) +- *Implemented By:* Amazon.CDK.aws_eks.Cluster, Amazon.CDK.aws_eks.FargateCluster, Amazon.CDK.aws_eks.ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`AddCdk8sChart\`](#amazoncdkawseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`AddHelmChart\`](#amazoncdkawseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`AddManifest\`](#amazoncdkawseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`AddServiceAccount\`](#amazoncdkawseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| AddCdk8sChart | Defines a CDK8s chart in this cluster. | +| AddHelmChart | Defines a Helm chart in this cluster. | +| AddManifest | Defines a Kubernetes resource in this cluster. | +| AddServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`AddCdk8sChart\` +##### \`AddCdk8sChart\` \`\`\`csharp private AddCdk8sChart(string Id, Construct Chart) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Chart\`Required +###### \`Chart\`Required -- *Type:* [\`Constructs.Construct\`](#Constructs.Construct) +- *Type:* Constructs.Construct the cdk8s chart. --- -##### \`AddHelmChart\` +##### \`AddHelmChart\` \`\`\`csharp private AddHelmChart(string Id, HelmChartOptions Options) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`Options\`Required +###### \`Options\`Required -- *Type:* [\`Amazon.CDK.aws_eks.HelmChartOptions\`](#Amazon.CDK.aws_eks.HelmChartOptions) +- *Type:* Amazon.CDK.aws_eks.HelmChartOptions options of this chart. --- -##### \`AddManifest\` +##### \`AddManifest\` \`\`\`csharp private AddManifest(string Id, System.Collections.Generic.IDictionary Manifest) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`Manifest\`Required +###### \`Manifest\`Required -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary a list of Kubernetes resource specifications. --- -##### \`AddServiceAccount\` +##### \`AddServiceAccount\` \`\`\`csharp private AddServiceAccount(string Id, ServiceAccountOptions Options = null) \`\`\` -###### \`Id\`Required +###### \`Id\`Required -- *Type:* \`string\` +- *Type:* string logical id of service account. --- -###### \`Options\`Optional +###### \`Options\`Optional -- *Type:* [\`Amazon.CDK.aws_eks.ServiceAccountOptions\`](#Amazon.CDK.aws_eks.ServiceAccountOptions) +- *Type:* Amazon.CDK.aws_eks.ServiceAccountOptions service account options. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawseksiclusterpropertynode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct tree node for this construct. | -| [\`Env\`](#amazoncdkawseksiclusterpropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawseksiclusterpropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`Connections\`](#amazoncdkawseksiclusterpropertyconnections)* | [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) | *No description.* | -| [\`ClusterArn\`](#amazoncdkawseksiclusterpropertyclusterarn)* | \`string\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`ClusterCertificateAuthorityData\`](#amazoncdkawseksiclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`ClusterEncryptionConfigKeyArn\`](#amazoncdkawseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`ClusterEndpoint\`](#amazoncdkawseksiclusterpropertyclusterendpoint)* | \`string\` | The API Server endpoint URL. | -| [\`ClusterName\`](#amazoncdkawseksiclusterpropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`ClusterSecurityGroup\`](#amazoncdkawseksiclusterpropertyclustersecuritygroup)* | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`ClusterSecurityGroupId\`](#amazoncdkawseksiclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`OpenIdConnectProvider\`](#amazoncdkawseksiclusterpropertyopenidconnectprovider)* | [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`Prune\`](#amazoncdkawseksiclusterpropertyprune)* | \`bool\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`Vpc\`](#amazoncdkawseksiclusterpropertyvpc)* | [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`KubectlEnvironment\`](#amazoncdkawseksiclusterpropertykubectlenvironment) | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`KubectlLayer\`](#amazoncdkawseksiclusterpropertykubectllayer) | [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`KubectlMemory\`](#amazoncdkawseksiclusterpropertykubectlmemory) | [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`KubectlPrivateSubnets\`](#amazoncdkawseksiclusterpropertykubectlprivatesubnets) | [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`KubectlRole\`](#amazoncdkawseksiclusterpropertykubectlrole) | [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`KubectlSecurityGroup\`](#amazoncdkawseksiclusterpropertykubectlsecuritygroup) | [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| Node | Amazon.CDK.ConstructNode | The construct tree node for this construct. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| Connections | Amazon.CDK.aws_ec2.Connections | *No description.* | +| ClusterArn | string | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| ClusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| ClusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| ClusterEndpoint | string | The API Server endpoint URL. | +| ClusterName | string | The physical name of the Cluster. | +| ClusterSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| ClusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| OpenIdConnectProvider | Amazon.CDK.aws_iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| Prune | bool | Indicates whether Kubernetes resources can be automatically pruned. | +| Vpc | Amazon.CDK.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| KubectlEnvironment | System.Collections.Generic.IDictionary | Custom environment variables when running \`kubectl\` against this cluster. | +| KubectlLayer | Amazon.CDK.aws_lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| KubectlMemory | Amazon.CDK.Size | Amount of memory to allocate to the provider's lambda function. | +| KubectlPrivateSubnets | Amazon.CDK.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| KubectlRole | Amazon.CDK.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| KubectlSecurityGroup | Amazon.CDK.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public ConstructNode Node { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -24687,131 +24847,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`Connections\`Required +##### \`Connections\`Required \`\`\`csharp public Connections Connections { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.Connections\`](#Amazon.CDK.aws_ec2.Connections) +- *Type:* Amazon.CDK.aws_ec2.Connections --- -##### \`ClusterArn\`Required +##### \`ClusterArn\`Required \`\`\`csharp public string ClusterArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`ClusterCertificateAuthorityData\`Required +##### \`ClusterCertificateAuthorityData\`Required \`\`\`csharp public string ClusterCertificateAuthorityData { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`ClusterEncryptionConfigKeyArn\`Required +##### \`ClusterEncryptionConfigKeyArn\`Required \`\`\`csharp public string ClusterEncryptionConfigKeyArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`ClusterEndpoint\`Required +##### \`ClusterEndpoint\`Required \`\`\`csharp public string ClusterEndpoint { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The API Server endpoint URL. --- -##### \`ClusterName\`Required +##### \`ClusterName\`Required \`\`\`csharp public string ClusterName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`ClusterSecurityGroup\`Required +##### \`ClusterSecurityGroup\`Required \`\`\`csharp public ISecurityGroup ClusterSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`ClusterSecurityGroupId\`Required +##### \`ClusterSecurityGroupId\`Required \`\`\`csharp public string ClusterSecurityGroupId { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`OpenIdConnectProvider\`Required +##### \`OpenIdConnectProvider\`Required \`\`\`csharp public IOpenIdConnectProvider OpenIdConnectProvider { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IOpenIdConnectProvider\`](#Amazon.CDK.aws_iam.IOpenIdConnectProvider) +- *Type:* Amazon.CDK.aws_iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`Prune\`Required +##### \`Prune\`Required \`\`\`csharp public bool Prune { get; } \`\`\` -- *Type:* \`bool\` +- *Type:* bool Indicates whether Kubernetes resources can be automatically pruned. @@ -24819,37 +24979,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`Vpc\`Required +##### \`Vpc\`Required \`\`\`csharp public IVpc Vpc { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.IVpc\`](#Amazon.CDK.aws_ec2.IVpc) +- *Type:* Amazon.CDK.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`KubectlEnvironment\`Optional +##### \`KubectlEnvironment\`Optional \`\`\`csharp public System.Collections.Generic.IDictionary KubectlEnvironment { get; } \`\`\` -- *Type:* System.Collections.Generic.IDictionary +- *Type:* System.Collections.Generic.IDictionary Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`KubectlLayer\`Optional +##### \`KubectlLayer\`Optional \`\`\`csharp public ILayerVersion KubectlLayer { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_lambda.ILayerVersion\`](#Amazon.CDK.aws_lambda.ILayerVersion) +- *Type:* Amazon.CDK.aws_lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -24857,25 +25017,25 @@ If not defined, a default layer will be used. --- -##### \`KubectlMemory\`Optional +##### \`KubectlMemory\`Optional \`\`\`csharp public Size KubectlMemory { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Size\`](#Amazon.CDK.Size) +- *Type:* Amazon.CDK.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`KubectlPrivateSubnets\`Optional +##### \`KubectlPrivateSubnets\`Optional \`\`\`csharp public ISubnet[] KubectlPrivateSubnets { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISubnet\`](#Amazon.CDK.aws_ec2.ISubnet)[] +- *Type:* Amazon.CDK.aws_ec2.ISubnet[] Subnets to host the \`kubectl\` compute resources. @@ -24883,13 +25043,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`KubectlRole\`Optional +##### \`KubectlRole\`Optional \`\`\`csharp public IRole KubectlRole { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_iam.IRole\`](#Amazon.CDK.aws_iam.IRole) +- *Type:* Amazon.CDK.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -24897,13 +25057,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`KubectlSecurityGroup\`Optional +##### \`KubectlSecurityGroup\`Optional \`\`\`csharp public ISecurityGroup KubectlSecurityGroup { get; } \`\`\` -- *Type:* [\`Amazon.CDK.aws_ec2.ISecurityGroup\`](#Amazon.CDK.aws_ec2.ISecurityGroup) +- *Type:* Amazon.CDK.aws_ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -24911,45 +25071,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource) +- *Extends:* Amazon.CDK.IResource -- *Implemented By:* [\`Amazon.CDK.aws_eks.Nodegroup\`](#Amazon.CDK.aws_eks.Nodegroup), [\`Amazon.CDK.aws_eks.INodegroup\`](#Amazon.CDK.aws_eks.INodegroup) +- *Implemented By:* Amazon.CDK.aws_eks.Nodegroup, Amazon.CDK.aws_eks.INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawseksinodegrouppropertynode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct tree node for this construct. | -| [\`Env\`](#amazoncdkawseksinodegrouppropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawseksinodegrouppropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`NodegroupName\`](#amazoncdkawseksinodegrouppropertynodegroupname)* | \`string\` | Name of the nodegroup. | +| Node | Amazon.CDK.ConstructNode | The construct tree node for this construct. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| NodegroupName | string | Name of the nodegroup. | --- -##### \`Node\`Required +##### \`Node\`Required \`\`\`csharp public ConstructNode Node { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- -##### \`Env\`Required +##### \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -24957,164 +25117,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`Stack\`Required +##### \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -##### \`NodegroupName\`Required +##### \`NodegroupName\`Required \`\`\`csharp public string NodegroupName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#amazoncdkawsekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#amazoncdkawsekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#amazoncdkawsekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#amazoncdkawsekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#amazoncdkawsekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#amazoncdkawsekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#amazoncdkawseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#amazoncdkawseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#amazoncdkawseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#amazoncdkawseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#amazoncdkawseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#amazoncdkawseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#amazoncdkawseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -25122,87 +25282,87 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#amazoncdkawseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#amazoncdkawseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#amazoncdkawseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` Inferentia instances. --- -### PatchType +### PatchType | **Name** | **Description** | | --- | --- | -| [\`JSON\`](#amazoncdkawsekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#amazoncdkawsekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#amazoncdkawsekspatchtypestrategic) | Strategic merge patch. | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | --- Values for \`kubectl patch\` --type argument. -#### \`JSON\` +#### \`JSON\` JSON Patch, RFC 6902. --- -#### \`MERGE\` +#### \`MERGE\` JSON Merge patch. --- -#### \`STRATEGIC\` +#### \`STRATEGIC\` Strategic merge patch. @@ -25211,7 +25371,7 @@ Strategic merge patch. " `; -exports[`custom link formatter 1`] = ` +exports[`java for package 1`] = ` "# Amazon ECR Construct Library --- @@ -25231,27 +25391,27 @@ This package contains constructs for working with Amazon Elastic Container Regis Define a repository by creating a new instance of \`Repository\`. A repository holds multiple verions of a single container image. -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -repository = ecr.Repository(self, \\"Repository\\") +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +Object repository = new Repository(this, \\"Repository\\"); \`\`\` ## Image scanning Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable \`imageScanOnPush\` in the properties -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -repository = ecr.Repository(stack, \\"Repo\\", - image_scan_on_push=True -) +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +Object repository = Repository.Builder.create(stack, \\"Repo\\") + .imageScanOnPush(true) + .build(); \`\`\` To create an \`onImageScanCompleted\` event rule and trigger the event target -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -repository.on_image_scan_completed(\\"ImageScanComplete\\").add_target(...) +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +repository.onImageScanCompleted(\\"ImageScanComplete\\").addTarget(...); \`\`\` ### Authorization Token @@ -25264,13 +25424,13 @@ More information can be found at at [Registry Authentication](https://docs.aws.a A Docker authorization token can be obtained using the \`GetAuthorizationToken\` ECR API. The following code snippets grants an IAM user access to call this API. -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -import aws_cdk.aws_iam as iam -import aws_cdk.aws_ecr as ecr +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +import software.amazon.awscdk.services.iam.*; +import software.amazon.awscdk.services.ecr.*; -user = iam.User(self, \\"User\\", ...) -ecr.AuthorizationToken.grant_read(user) +User user = new User(this, \\"User\\", new UserProps()...); +AuthorizationToken.grantRead(user); \`\`\` If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from @@ -25280,13 +25440,13 @@ higher rate and bandwidth limits. The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery. -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -import aws_cdk.aws_iam as iam -import aws_cdk.aws_ecr as ecr +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +import software.amazon.awscdk.services.iam.*; +import software.amazon.awscdk.services.ecr.*; -user = iam.User(self, \\"User\\", ...) -ecr.PublicGalleryAuthorizationToken.grant_read(user) +User user = new User(this, \\"User\\", new UserProps()...); +PublicGalleryAuthorizationToken.grantRead(user); \`\`\` This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth). @@ -25295,9 +25455,9 @@ This user can then proceed to login to the registry using one of the [authentica You can set tag immutability on images in our repository using the \`imageTagMutability\` construct prop. -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -ecr.Repository(stack, \\"Repo\\", image_tag_mutability=ecr.TagMutability.IMMUTABLE) +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +Repository.Builder.create(stack, \\"Repo\\").imageTagMutability(ecr.getTagMutability().getIMMUTABLE()).build(); \`\`\` ## Automatically clean up repositories @@ -25308,68 +25468,66 @@ against that image. For example, the following deletes images older than 30 days, while keeping all images tagged with prod (note that the order is important here): -\`\`\`python -# Example automatically generated from non-compiling source. May contain errors. -repository.add_lifecycle_rule(tag_prefix_list=[\\"prod\\"], max_image_count=9999) -repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) +\`\`\`java +// Example automatically generated from non-compiling source. May contain errors. +repository.addLifecycleRule(Map.of(\\"tagPrefixList\\", List.of(\\"prod\\"), \\"maxImageCount\\", 9999)); +repository.addLifecycleRule(Map.of(\\"maxImageAge\\", cdk.Duration.days(30))); \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#custom-aws_cdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnPublicRepository; -aws_cdk.aws_ecr.CfnPublicRepository( - scope: Construct, - id: str, - repository_catalog_data: typing.Any = None, - repository_name: str = None, - repository_policy_text: typing.Any = None, - tags: typing.List[CfnTag] = None -) +CfnPublicRepository.Builder.create(Construct scope, java.lang.String id) +// .repositoryCatalogData(java.lang.Object) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`repository_catalog_data\`Optional +##### \`repositoryCatalogData\`Optional -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -25377,9 +25535,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -25387,9 +25545,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repositoryPolicyText\`Optional -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -25397,9 +25555,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -25407,60 +25565,58 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` -\`\`\`python -def inspect( - inspector: TreeInspector -) +\`\`\`java +public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#custom-aws_cdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnpublicrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#custom-aws_cdk.core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`attr_arn\`Required +##### \`attrArn\`Required -\`\`\`python -attr_arn: str +\`\`\`java +public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required -\`\`\`python -tags: TagManager +\`\`\`java +public TagManager getTags(); \`\`\` -- *Type:* [\`aws_cdk.core.TagManager\`](#custom-aws_cdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -25468,13 +25624,13 @@ tags: TagManager --- -##### \`repository_catalog_data\`Required +##### \`repositoryCatalogData\`Required -\`\`\`python -repository_catalog_data: typing.Any +\`\`\`java +public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -25482,13 +25638,13 @@ repository_catalog_data: typing.Any --- -##### \`repository_policy_text\`Required +##### \`repositoryPolicyText\`Required -\`\`\`python -repository_policy_text: typing.Any +\`\`\`java +public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -25496,13 +25652,13 @@ repository_policy_text: typing.Any --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -25510,69 +25666,71 @@ repository_name: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`aws_cdk.core.IInspectable\`](#custom-aws_cdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnRegistryPolicy; -aws_cdk.aws_ecr.CfnRegistryPolicy( - scope: Construct, - id: str, - policy_text: typing.Any -) +CfnRegistryPolicy.Builder.create(Construct scope, java.lang.String id) + .policyText(java.lang.Object) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnregistrypolicyparameterscope)* | [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnregistrypolicyparameterid)* | \`str\` | scoped id of the resource. | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropsparameterpolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`policy_text\`Required +##### \`policyText\`Required -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -25580,57 +25738,55 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` -\`\`\`python -def inspect( - inspector: TreeInspector -) +\`\`\`java +public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#custom-aws_cdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`str\` | *No description.* | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| attrRegistryId | java.lang.String | *No description.* | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attr_registry_id\`Required +##### \`attrRegistryId\`Required -\`\`\`python -attr_registry_id: str +\`\`\`java +public java.lang.String getAttrRegistryId(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`policy_text\`Required +##### \`policyText\`Required -\`\`\`python -policy_text: typing.Any +\`\`\`java +public java.lang.Object getPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -25638,69 +25794,72 @@ policy_text: typing.Any --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`aws_cdk.core.IInspectable\`](#custom-aws_cdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration; -aws_cdk.aws_ecr.CfnReplicationConfiguration( - scope: Construct, - id: str, - replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] -) +CfnReplicationConfiguration.Builder.create(Construct scope, java.lang.String id) + .replicationConfiguration(IResolvable) + .replicationConfiguration(ReplicationConfigurationProperty) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnreplicationconfigurationparameterscope)* | [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnreplicationconfigurationparameterid)* | \`str\` | scoped id of the resource. | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropsparameterreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`replication_configuration\`Required +##### \`replicationConfiguration\`Required -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -25708,57 +25867,55 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` -\`\`\`python -def inspect( - inspector: TreeInspector -) +\`\`\`java +public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#custom-aws_cdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`str\` | *No description.* | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attrRegistryId | java.lang.String | *No description.* | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attr_registry_id\`Required +##### \`attrRegistryId\`Required -\`\`\`python -attr_registry_id: str +\`\`\`java +public java.lang.String getAttrRegistryId(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`replication_configuration\`Required +##### \`replicationConfiguration\`Required -\`\`\`python -replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\`java +public java.lang.Object getReplicationConfiguration(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -25766,81 +25923,84 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#custom-aws_cdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnRepository; -aws_cdk.aws_ecr.CfnRepository( - scope: Construct, - id: str, - encryption_configuration: typing.Any = None, - image_scanning_configuration: typing.Any = None, - image_tag_mutability: str = None, - lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, - repository_name: str = None, - repository_policy_text: typing.Any = None, - tags: typing.List[CfnTag] = None -) +CfnRepository.Builder.create(Construct scope, java.lang.String id) +// .encryptionConfiguration(java.lang.Object) +// .imageScanningConfiguration(java.lang.Object) +// .imageTagMutability(java.lang.String) +// .lifecyclePolicy(IResolvable) +// .lifecyclePolicy(LifecyclePolicyProperty) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropsparameterencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropsparameterimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropsparameterimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropsparameterlifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::Repository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#custom-aws_cdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`encryption_configuration\`Optional +##### \`encryptionConfiguration\`Optional -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -25848,9 +26008,9 @@ scoped id of the resource. --- -##### \`image_scanning_configuration\`Optional +##### \`imageScanningConfiguration\`Optional -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -25858,9 +26018,9 @@ scoped id of the resource. --- -##### \`image_tag_mutability\`Optional +##### \`imageTagMutability\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -25868,9 +26028,9 @@ scoped id of the resource. --- -##### \`lifecycle_policy\`Optional +##### \`lifecyclePolicy\`Optional -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -25878,9 +26038,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -25888,9 +26048,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repositoryPolicyText\`Optional -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -25898,9 +26058,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] +- *Type:* java.util.List \`AWS::ECR::Repository.Tags\`. @@ -25908,74 +26068,72 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` -\`\`\`python -def inspect( - inspector: TreeInspector -) +\`\`\`java +public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#custom-aws_cdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`attr_repository_uri\`](#awscdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#custom-aws_cdk.core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attrArn | java.lang.String | *No description.* | +| attrRepositoryUri | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attr_arn\`Required +##### \`attrArn\`Required -\`\`\`python -attr_arn: str +\`\`\`java +public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`attr_repository_uri\`Required +##### \`attrRepositoryUri\`Required -\`\`\`python -attr_repository_uri: str +\`\`\`java +public java.lang.String getAttrRepositoryUri(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required -\`\`\`python -tags: TagManager +\`\`\`java +public TagManager getTags(); \`\`\` -- *Type:* [\`aws_cdk.core.TagManager\`](#custom-aws_cdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -25983,13 +26141,13 @@ tags: TagManager --- -##### \`encryption_configuration\`Required +##### \`encryptionConfiguration\`Required -\`\`\`python -encryption_configuration: typing.Any +\`\`\`java +public java.lang.Object getEncryptionConfiguration(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -25997,13 +26155,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Required +##### \`imageScanningConfiguration\`Required -\`\`\`python -image_scanning_configuration: typing.Any +\`\`\`java +public java.lang.Object getImageScanningConfiguration(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -26011,13 +26169,13 @@ image_scanning_configuration: typing.Any --- -##### \`repository_policy_text\`Required +##### \`repositoryPolicyText\`Required -\`\`\`python -repository_policy_text: typing.Any +\`\`\`java +public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -26025,13 +26183,13 @@ repository_policy_text: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`imageTagMutability\`Optional -\`\`\`python -image_tag_mutability: str +\`\`\`java +public java.lang.String getImageTagMutability(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -26039,13 +26197,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecyclePolicy\`Optional -\`\`\`python -lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\`java +public java.lang.Object getLifecyclePolicy(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -26053,13 +26211,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -26067,80 +26225,82 @@ repository_name: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.Repository; -aws_cdk.aws_ecr.Repository( - scope: Construct, - id: str, - image_scan_on_push: bool = None, - image_tag_mutability: TagMutability = None, - lifecycle_registry_id: str = None, - lifecycle_rules: typing.List[LifecycleRule] = None, - removal_policy: RemovalPolicy = None, - repository_name: str = None -) +Repository.Builder.create(Construct scope, java.lang.String id) +// .imageScanOnPush(java.lang.Boolean) +// .imageTagMutability(TagMutability) +// .lifecycleRegistryId(java.lang.String) +// .lifecycleRules(java.util.List) +// .removalPolicy(RemovalPolicy) +// .repositoryName(java.lang.String) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositoryparameterscope)* | [\`constructs.Construct\`](#custom-constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositoryparameterid)* | \`str\` | *No description.* | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropsparameterimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropsparameterimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#custom-aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropsparameterlifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropsparameterlifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#custom-aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropsparameterremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#custom-aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropsparameterrepositoryname) | \`str\` | Name for this repository. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| imageScanOnPush | java.lang.Boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | java.lang.String | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | java.util.List<LifecycleRule> | Life cycle rules to apply to this registry. | +| removalPolicy | software.amazon.awscdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | java.lang.String | Name for this repository. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#custom-constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`image_scan_on_push\`Optional +##### \`imageScanOnPush\`Optional -- *Type:* \`bool\` +- *Type:* java.lang.Boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`imageTagMutability\`Optional -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#custom-aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -26149,371 +26309,282 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycleRegistryId\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycleRules\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#custom-aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* java.util.List<LifecycleRule> - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removalPolicy\`Optional -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#custom-aws_cdk.core.RemovalPolicy) +- *Type:* software.amazon.awscdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* Automatically generated name. Name for this repository. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_lifecycle_rule\`](#awscdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| addLifecycleRule | Add a life cycle rule to the repository. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`add_lifecycle_rule\` +##### \`addLifecycleRule\` -\`\`\`python -def add_lifecycle_rule( - description: str = None, - max_image_age: Duration = None, - max_image_count: typing.Union[int, float] = None, - rule_priority: typing.Union[int, float] = None, - tag_prefix_list: typing.List[str] = None, - tag_status: TagStatus = None -) +\`\`\`java +public addLifecycleRule(LifecycleRule rule) \`\`\` -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -Describes the purpose of the rule. - ---- - -###### \`max_image_age\`Optional - -- *Type:* [\`aws_cdk.core.Duration\`](#custom-aws_cdk.core.Duration) - -The maximum age of images to retain. The value must represent a number of days. - -Specify exactly one of maxImageCount and maxImageAge. - ---- - -###### \`max_image_count\`Optional - -- *Type:* \`typing.Union[int, float]\` - -The maximum number of images to retain. - -Specify exactly one of maxImageCount and maxImageAge. - ---- - -###### \`rule_priority\`Optional - -- *Type:* \`typing.Union[int, float]\` -- *Default:* Automatically assigned - -Controls the order in which rules are evaluated (low to high). - -All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. - ---- - -###### \`tag_prefix_list\`Optional - -- *Type:* typing.List[\`str\`] - -Select images that have ALL the given prefixes in their tag. - -Only if tagStatus == TagStatus.Tagged - ---- +###### \`rule\`Required -###### \`tag_status\`Optional - -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#custom-aws_cdk.aws_ecr.TagStatus) -- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise - -Select images based on tags. - -Only one rule is allowed to select untagged images, and it must have the highest rulePriority. +- *Type:* LifecycleRule --- -##### \`add_to_resource_policy\` +##### \`addToResourcePolicy\` -\`\`\`python -def add_to_resource_policy( - statement: PolicyStatement -) +\`\`\`java +public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#custom-aws_cdk.aws_iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arn_for_local_repository\`](#awscdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`from_repository_arn\`](#awscdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`from_repository_attributes\`](#awscdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`from_repository_name\`](#awscdkawsecrrepositoryfromrepositoryname) | *No description.* | +| arnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| fromRepositoryArn | *No description.* | +| fromRepositoryAttributes | Import a repository. | +| fromRepositoryName | *No description.* | --- -##### \`arn_for_local_repository\` +##### \`arnForLocalRepository\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.Repository; -aws_cdk.aws_ecr.Repository.arn_for_local_repository( - repository_name: str, - scope: IConstruct, - account: str = None -) +Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope),Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope, java.lang.String account) \`\`\` -###### \`repository_name\`Required +###### \`repositoryName\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.IConstruct\`](#custom-constructs.IConstruct) +- *Type:* software.constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`from_repository_arn\` +##### \`fromRepositoryArn\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.Repository; -aws_cdk.aws_ecr.Repository.from_repository_arn( - scope: Construct, - id: str, - repository_arn: str -) +Repository.fromRepositoryArn(Construct scope, java.lang.String id, java.lang.String repositoryArn) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#custom-constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -###### \`repository_arn\`Required +###### \`repositoryArn\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`from_repository_attributes\` +##### \`fromRepositoryAttributes\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.Repository; -aws_cdk.aws_ecr.Repository.from_repository_attributes( - scope: Construct, - id: str, - repository_arn: str, - repository_name: str -) +Repository.fromRepositoryAttributes(Construct scope, java.lang.String id, RepositoryAttributes attrs) \`\`\` -###### \`scope\`Required - -- *Type:* [\`constructs.Construct\`](#custom-constructs.Construct) - ---- - -###### \`id\`Required +###### \`scope\`Required -- *Type:* \`str\` +- *Type:* software.constructs.Construct --- -###### \`repository_arn\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -###### \`repository_name\`Required +###### \`attrs\`Required -- *Type:* \`str\` +- *Type:* RepositoryAttributes --- -##### \`from_repository_name\` +##### \`fromRepositoryName\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.Repository; -aws_cdk.aws_ecr.Repository.from_repository_name( - scope: Construct, - id: str, - repository_name: str -) +Repository.fromRepositoryName(Construct scope, java.lang.String id, java.lang.String repositoryName) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#custom-constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -###### \`repository_name\`Required +###### \`repositoryName\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | --- -##### \`repository_arn\`Required +##### \`repositoryArn\`Required -\`\`\`python -repository_arn: str +\`\`\`java +public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repositoryName\`Required -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`aws_cdk.aws_ecr.IRepository\`](#custom-aws_cdk.aws_ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.RepositoryBase; -aws_cdk.aws_ecr.RepositoryBase( - scope: Construct, - id: str, - account: str = None, - environment_from_arn: str = None, - physical_name: str = None, - region: str = None -) +RepositoryBase.Builder.create(Construct scope, java.lang.String id) +// .account(java.lang.String) +// .environmentFromArn(java.lang.String) +// .physicalName(java.lang.String) +// .region(java.lang.String) + .build(); \`\`\` | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositorybaseparameterscope)* | [\`constructs.Construct\`](#custom-constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositorybaseparameterid)* | \`str\` | *No description.* | -| [\`account\`](#awscdkcoreresourcepropsparameteraccount) | \`str\` | The AWS account ID this resource belongs to. | -| [\`environment_from_arn\`](#awscdkcoreresourcepropsparameterenvironmentfromarn) | \`str\` | ARN to deduce region and account from. | -| [\`physical_name\`](#awscdkcoreresourcepropsparameterphysicalname) | \`str\` | The value passed in by users to the physical name prop of the resource. | -| [\`region\`](#awscdkcoreresourcepropsparameterregion) | \`str\` | The AWS region this resource belongs to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| account | java.lang.String | The AWS account ID this resource belongs to. | +| environmentFromArn | java.lang.String | ARN to deduce region and account from. | +| physicalName | java.lang.String | The value passed in by users to the physical name prop of the resource. | +| region | java.lang.String | The AWS region this resource belongs to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#custom-constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`account\`Optional +##### \`account\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* the resource is in the same account as the stack it belongs to The AWS account ID this resource belongs to. --- -##### \`environment_from_arn\`Optional +##### \`environmentFromArn\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. ARN to deduce region and account from. @@ -26522,9 +26593,9 @@ The ARN is parsed and the account and region are taken from the ARN. This should --- -##### \`physical_name\`Optional +##### \`physicalName\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* The physical name will be allocated by CloudFormation at deployment time The value passed in by users to the physical name prop of the resource. @@ -26533,429 +26604,246 @@ The value passed in by users to the physical name prop of the resource. --- -##### \`region\`Optional +##### \`region\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* the resource is in the same region as the stack it belongs to The AWS region this resource belongs to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to use the images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`addToResourcePolicy\` -\`\`\`python -def add_to_resource_policy( - statement: PolicyStatement -) +\`\`\`java +public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#custom-aws_cdk.aws_iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` -\`\`\`python -def grant( - grantee: IGrantable, - actions: str -) +\`\`\`java +public grant(IGrantable grantee, java.lang.String actions) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`grant_pull\` +##### \`grantPull\` -\`\`\`python -def grant_pull( - grantee: IGrantable -) +\`\`\`java +public grantPull(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grantPullPush\` -\`\`\`python -def grant_pull_push( - grantee: IGrantable -) +\`\`\`java +public grantPullPush(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`onCloudTrailEvent\` -\`\`\`python -def on_cloud_trail_event( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None -) +\`\`\`java +public onCloudTrailEvent(java.lang.String id) +public onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -###### \`target\`Optional +###### \`options\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. +- *Type:* software.amazon.awscdk.services.events.OnEventOptions -The target to register for the event. +Options for adding the rule. --- -##### \`on_cloud_trail_image_pushed\` +##### \`onCloudTrailImagePushed\` -\`\`\`python -def on_cloud_trail_image_pushed( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tag: str = None -) +\`\`\`java +public onCloudTrailImagePushed(java.lang.String id) +public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -###### \`target\`Optional - -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -###### \`image_tag\`Optional +###### \`options\`Optional -- *Type:* \`str\` -- *Default:* Watch changes to all tags +- *Type:* OnCloudTrailImagePushedOptions -Only watch changes to this image tag. +Options for adding the rule. --- -##### \`on_event\` +##### \`onEvent\` -\`\`\`python -def on_event( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None -) +\`\`\`java +public onEvent(java.lang.String id) +public onEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required - -- *Type:* \`str\` - ---- - -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- +###### \`id\`Required -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. +- *Type:* java.lang.String --- -###### \`target\`Optional +###### \`options\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. +- *Type:* software.amazon.awscdk.services.events.OnEventOptions --- -##### \`on_image_scan_completed\` +##### \`onImageScanCompleted\` -\`\`\`python -def on_image_scan_completed( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tags: typing.List[str] = None -) +\`\`\`java +public onImageScanCompleted(java.lang.String id) +public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -###### \`target\`Optional - -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -###### \`image_tags\`Optional - -- *Type:* typing.List[\`str\`] -- *Default:* Watch the changes to the repository with all image tags +###### \`options\`Optional -Only watch changes to the image tags spedified. +- *Type:* OnImageScanCompletedOptions -Leave it undefined to watch the full repository. +Options for adding the rule. --- -##### \`repository_uri_for_digest\` +##### \`repositoryUriForDigest\` -\`\`\`python -def repository_uri_for_digest( - digest: str = None -) +\`\`\`java +public repositoryUriForDigest() +public repositoryUriForDigest(java.lang.String digest) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String Optional image digest. --- -##### \`repository_uri_for_tag\` +##### \`repositoryUriForTag\` -\`\`\`python -def repository_uri_for_tag( - tag: str = None -) +\`\`\`java +public repositoryUriForTag() +public repositoryUriForTag(java.lang.String tag) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorybasepropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorybasepropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrrepositorybasepropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | +| repositoryUri | java.lang.String | The URI of this repository (represents the latest image):. | --- -##### \`repository_arn\`Required +##### \`repositoryArn\`Required -\`\`\`python -repository_arn: str +\`\`\`java +public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repositoryName\`Required -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The name of the repository. --- -##### \`repository_uri\`Required +##### \`repositoryUri\`Required -\`\`\`python -repository_uri: str +\`\`\`java +public java.lang.String getRepositoryUri(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The URI of this repository (represents the latest image):. @@ -26964,45 +26852,45 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps; -aws_cdk.aws_ecr.CfnPublicRepositoryProps( - repository_catalog_data: typing.Any = None, - repository_name: str = None, - repository_policy_text: typing.Any = None, - tags: typing.List[CfnTag] = None -) +CfnPublicRepositoryProps.builder() +// .repositoryCatalogData(java.lang.Object) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repository_catalog_data\`Optional +##### \`repositoryCatalogData\`Optional -\`\`\`python -repository_catalog_data: typing.Any +\`\`\`java +public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -27010,13 +26898,13 @@ repository_catalog_data: typing.Any --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -27024,13 +26912,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repositoryPolicyText\`Optional -\`\`\`python -repository_policy_text: typing.Any +\`\`\`java +public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -27038,13 +26926,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional -\`\`\`python -tags: typing.List[CfnTag] +\`\`\`java +public java.util.List getTags(); \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -27052,37 +26940,37 @@ tags: typing.List[CfnTag] --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnRegistryPolicyProps; -aws_cdk.aws_ecr.CfnRegistryPolicyProps( - policy_text: typing.Any -) +CfnRegistryPolicyProps.builder() + .policyText(java.lang.Object) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policy_text\`Required +##### \`policyText\`Required -\`\`\`python -policy_text: typing.Any +\`\`\`java +public java.lang.Object getPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -27090,37 +26978,38 @@ policy_text: typing.Any --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnReplicationConfigurationProps; -aws_cdk.aws_ecr.CfnReplicationConfigurationProps( - replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] -) +CfnReplicationConfigurationProps.builder() + .replicationConfiguration(IResolvable) + .replicationConfiguration(ReplicationConfigurationProperty) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replication_configuration\`Required +##### \`replicationConfiguration\`Required -\`\`\`python -replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\`java +public java.lang.Object getReplicationConfiguration(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -27128,49 +27017,50 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnRepositoryProps; -aws_cdk.aws_ecr.CfnRepositoryProps( - encryption_configuration: typing.Any = None, - image_scanning_configuration: typing.Any = None, - image_tag_mutability: str = None, - lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, - repository_name: str = None, - repository_policy_text: typing.Any = None, - tags: typing.List[CfnTag] = None -) +CfnRepositoryProps.builder() +// .encryptionConfiguration(java.lang.Object) +// .imageScanningConfiguration(java.lang.Object) +// .imageTagMutability(java.lang.String) +// .lifecyclePolicy(IResolvable) +// .lifecyclePolicy(LifecyclePolicyProperty) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropspropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryption_configuration\`Optional +##### \`encryptionConfiguration\`Optional -\`\`\`python -encryption_configuration: typing.Any +\`\`\`java +public java.lang.Object getEncryptionConfiguration(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -27178,13 +27068,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Optional +##### \`imageScanningConfiguration\`Optional -\`\`\`python -image_scanning_configuration: typing.Any +\`\`\`java +public java.lang.Object getImageScanningConfiguration(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -27192,13 +27082,13 @@ image_scanning_configuration: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`imageTagMutability\`Optional -\`\`\`python -image_tag_mutability: str +\`\`\`java +public java.lang.String getImageTagMutability(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -27206,13 +27096,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecyclePolicy\`Optional -\`\`\`python -lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\`java +public java.lang.Object getLifecyclePolicy(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#custom-aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -27220,13 +27110,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -27234,13 +27124,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repositoryPolicyText\`Optional -\`\`\`python -repository_policy_text: typing.Any +\`\`\`java +public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`typing.Any\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -27248,13 +27138,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional -\`\`\`python -tags: typing.List[CfnTag] +\`\`\`java +public java.util.List getTags(); \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#custom-aws_cdk.core.CfnTag)] +- *Type:* java.util.List \`AWS::ECR::Repository.Tags\`. @@ -27262,37 +27152,37 @@ tags: typing.List[CfnTag] --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty; -aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( - lifecycle_policy_text: str = None, - registry_id: str = None -) +LifecyclePolicyProperty.builder() +// .lifecyclePolicyText(java.lang.String) +// .registryId(java.lang.String) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecycle_policy_text\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registry_id\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecyclePolicyText | java.lang.String | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registryId | java.lang.String | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecycle_policy_text\`Optional +##### \`lifecyclePolicyText\`Optional -\`\`\`python -lifecycle_policy_text: str +\`\`\`java +public java.lang.String getLifecyclePolicyText(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -27300,13 +27190,13 @@ lifecycle_policy_text: str --- -##### \`registry_id\`Optional +##### \`registryId\`Optional -\`\`\`python -registry_id: str +\`\`\`java +public java.lang.String getRegistryId(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -27314,58 +27204,58 @@ registry_id: str --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.LifecycleRule; -aws_cdk.aws_ecr.LifecycleRule( - description: str = None, - max_image_age: Duration = None, - max_image_count: typing.Union[int, float] = None, - rule_priority: typing.Union[int, float] = None, - tag_prefix_list: typing.List[str] = None, - tag_status: TagStatus = None -) +LifecycleRule.builder() +// .description(java.lang.String) +// .maxImageAge(Duration) +// .maxImageCount(java.lang.Number) +// .rulePriority(java.lang.Number) +// .tagPrefixList(java.util.List) +// .tagStatus(TagStatus) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecrlifecyclerulepropertydescription) | \`str\` | Describes the purpose of the rule. | -| [\`max_image_age\`](#awscdkawsecrlifecyclerulepropertymaximageage) | [\`aws_cdk.core.Duration\`](#custom-aws_cdk.core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`max_image_count\`](#awscdkawsecrlifecyclerulepropertymaximagecount) | \`typing.Union[int, float]\` | The maximum number of images to retain. | -| [\`rule_priority\`](#awscdkawsecrlifecyclerulepropertyrulepriority) | \`typing.Union[int, float]\` | Controls the order in which rules are evaluated (low to high). | -| [\`tag_prefix_list\`](#awscdkawsecrlifecyclerulepropertytagprefixlist) | typing.List[\`str\`] | Select images that have ALL the given prefixes in their tag. | -| [\`tag_status\`](#awscdkawsecrlifecyclerulepropertytagstatus) | [\`aws_cdk.aws_ecr.TagStatus\`](#custom-aws_cdk.aws_ecr.TagStatus) | Select images based on tags. | +| description | java.lang.String | Describes the purpose of the rule. | +| maxImageAge | software.amazon.awscdk.core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| maxImageCount | java.lang.Number | The maximum number of images to retain. | +| rulePriority | java.lang.Number | Controls the order in which rules are evaluated (low to high). | +| tagPrefixList | java.util.List | Select images that have ALL the given prefixes in their tag. | +| tagStatus | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional -\`\`\`python -description: str +\`\`\`java +public java.lang.String getDescription(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* No description Describes the purpose of the rule. --- -##### \`max_image_age\`Optional +##### \`maxImageAge\`Optional -\`\`\`python -max_image_age: Duration +\`\`\`java +public Duration getMaxImageAge(); \`\`\` -- *Type:* [\`aws_cdk.core.Duration\`](#custom-aws_cdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -27373,13 +27263,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`max_image_count\`Optional +##### \`maxImageCount\`Optional -\`\`\`python -max_image_count: typing.Union[int, float] +\`\`\`java +public java.lang.Number getMaxImageCount(); \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* java.lang.Number The maximum number of images to retain. @@ -27387,13 +27277,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rule_priority\`Optional +##### \`rulePriority\`Optional -\`\`\`python -rule_priority: typing.Union[int, float] +\`\`\`java +public java.lang.Number getRulePriority(); \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* java.lang.Number - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -27402,13 +27292,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tag_prefix_list\`Optional +##### \`tagPrefixList\`Optional -\`\`\`python -tag_prefix_list: typing.List[str] +\`\`\`java +public java.util.List getTagPrefixList(); \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* java.util.List Select images that have ALL the given prefixes in their tag. @@ -27416,13 +27306,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tag_status\`Optional +##### \`tagStatus\`Optional -\`\`\`python -tag_status: TagStatus +\`\`\`java +public TagStatus getTagStatus(); \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#custom-aws_cdk.aws_ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -27431,198 +27321,198 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions; -aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tag: str = None -) +OnCloudTrailImagePushedOptions.builder() +// .description(java.lang.String) +// .eventPattern(EventPattern) +// .ruleName(java.lang.String) +// .target(IRuleTarget) +// .imageTag(java.lang.String) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tag\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`str\` | Only watch changes to this image tag. | +| description | java.lang.String | A description of the rule's purpose. | +| eventPattern | software.amazon.awscdk.services.events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | java.lang.String | A name for the rule. | +| target | software.amazon.awscdk.services.events.IRuleTarget | The target to register for the event. | +| imageTag | java.lang.String | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional -\`\`\`python -description: str +\`\`\`java +public java.lang.String getDescription(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`eventPattern\`Optional -\`\`\`python -event_pattern: EventPattern +\`\`\`java +public EventPattern getEventPattern(); \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) +- *Type:* software.amazon.awscdk.services.events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`ruleName\`Optional -\`\`\`python -rule_name: str +\`\`\`java +public java.lang.String getRuleName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional -\`\`\`python -target: IRuleTarget +\`\`\`java +public IRuleTarget getTarget(); \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) +- *Type:* software.amazon.awscdk.services.events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tag\`Optional +##### \`imageTag\`Optional -\`\`\`python -image_tag: str +\`\`\`java +public java.lang.String getImageTag(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions; -aws_cdk.aws_ecr.OnImageScanCompletedOptions( - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tags: typing.List[str] = None -) +OnImageScanCompletedOptions.builder() +// .description(java.lang.String) +// .eventPattern(EventPattern) +// .ruleName(java.lang.String) +// .target(IRuleTarget) +// .imageTags(java.util.List) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecronimagescancompletedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecronimagescancompletedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecronimagescancompletedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tags\`](#awscdkawsecronimagescancompletedoptionspropertyimagetags) | typing.List[\`str\`] | Only watch changes to the image tags spedified. | +| description | java.lang.String | A description of the rule's purpose. | +| eventPattern | software.amazon.awscdk.services.events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | java.lang.String | A name for the rule. | +| target | software.amazon.awscdk.services.events.IRuleTarget | The target to register for the event. | +| imageTags | java.util.List | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional -\`\`\`python -description: str +\`\`\`java +public java.lang.String getDescription(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`eventPattern\`Optional -\`\`\`python -event_pattern: EventPattern +\`\`\`java +public EventPattern getEventPattern(); \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) +- *Type:* software.amazon.awscdk.services.events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`ruleName\`Optional -\`\`\`python -rule_name: str +\`\`\`java +public java.lang.String getRuleName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional -\`\`\`python -target: IRuleTarget +\`\`\`java +public IRuleTarget getTarget(); \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) +- *Type:* software.amazon.awscdk.services.events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tags\`Optional +##### \`imageTags\`Optional -\`\`\`python -image_tags: typing.List[str] +\`\`\`java +public java.util.List getImageTags(); \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* java.util.List - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -27631,35 +27521,37 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty; -aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( - rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] -) +ReplicationConfigurationProperty.builder() + .rules(IResolvable) + .rules(java.util.List) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#awscdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationRuleProperty> | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required -\`\`\`python -rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +\`\`\`java +public java.lang.Object getRules(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationRuleProperty> \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -27667,37 +27559,37 @@ rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Replicati --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty; -aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( - region: str, - registry_id: str -) +ReplicationDestinationProperty.builder() + .region(java.lang.String) + .registryId(java.lang.String) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registry_id\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | java.lang.String | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registryId | java.lang.String | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required -\`\`\`python -region: str +\`\`\`java +public java.lang.String getRegion(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -27705,13 +27597,13 @@ region: str --- -##### \`registry_id\`Required +##### \`registryId\`Required -\`\`\`python -registry_id: str +\`\`\`java +public java.lang.String getRegistryId(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -27719,35 +27611,37 @@ registry_id: str --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer - -\`\`\`python -import aws_cdk.aws_ecr +#### Initializer -aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( - destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] -) +\`\`\`java +import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty; + +ReplicationRuleProperty.builder() + .destinations(IResolvable) + .destinations(java.util.List) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#awscdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationDestinationProperty> | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required -\`\`\`python -destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +\`\`\`java +public java.lang.Object getDestinations(); \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#custom-aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#custom-aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationDestinationProperty> \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -27755,98 +27649,98 @@ destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Re --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.RepositoryAttributes; -aws_cdk.aws_ecr.RepositoryAttributes( - repository_arn: str, - repository_name: str -) +RepositoryAttributes.builder() + .repositoryArn(java.lang.String) + .repositoryName(java.lang.String) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositoryattributespropertyrepositoryarn)* | \`str\` | *No description.* | -| [\`repository_name\`](#awscdkawsecrrepositoryattributespropertyrepositoryname)* | \`str\` | *No description.* | +| repositoryArn | java.lang.String | *No description.* | +| repositoryName | java.lang.String | *No description.* | --- -##### \`repository_arn\`Required +##### \`repositoryArn\`Required -\`\`\`python -repository_arn: str +\`\`\`java +public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`repository_name\`Required +##### \`repositoryName\`Required -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.RepositoryProps; -aws_cdk.aws_ecr.RepositoryProps( - image_scan_on_push: bool = None, - image_tag_mutability: TagMutability = None, - lifecycle_registry_id: str = None, - lifecycle_rules: typing.List[LifecycleRule] = None, - removal_policy: RemovalPolicy = None, - repository_name: str = None -) +RepositoryProps.builder() +// .imageScanOnPush(java.lang.Boolean) +// .imageTagMutability(TagMutability) +// .lifecycleRegistryId(java.lang.String) +// .lifecycleRules(java.util.List) +// .removalPolicy(RemovalPolicy) +// .repositoryName(java.lang.String) + .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropspropertyimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropspropertyimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#custom-aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropspropertylifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropspropertylifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#custom-aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropspropertyremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#custom-aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropspropertyrepositoryname) | \`str\` | Name for this repository. | +| imageScanOnPush | java.lang.Boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | java.lang.String | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | java.util.List<LifecycleRule> | Life cycle rules to apply to this registry. | +| removalPolicy | software.amazon.awscdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | java.lang.String | Name for this repository. | --- -##### \`image_scan_on_push\`Optional +##### \`imageScanOnPush\`Optional -\`\`\`python -image_scan_on_push: bool +\`\`\`java +public java.lang.Boolean getImageScanOnPush(); \`\`\` -- *Type:* \`bool\` +- *Type:* java.lang.Boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`imageTagMutability\`Optional -\`\`\`python -image_tag_mutability: TagMutability +\`\`\`java +public TagMutability getImageTagMutability(); \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#custom-aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -27855,542 +27749,355 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycleRegistryId\`Optional -\`\`\`python -lifecycle_registry_id: str +\`\`\`java +public java.lang.String getLifecycleRegistryId(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycleRules\`Optional -\`\`\`python -lifecycle_rules: typing.List[LifecycleRule] +\`\`\`java +public java.util.List getLifecycleRules(); \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#custom-aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* java.util.List<LifecycleRule> - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removalPolicy\`Optional -\`\`\`python -removal_policy: RemovalPolicy +\`\`\`java +public RemovalPolicy getRemovalPolicy(); \`\`\` -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#custom-aws_cdk.core.RemovalPolicy) +- *Type:* software.amazon.awscdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repositoryName\`Optional -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grantRead\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.AuthorizationToken; -aws_cdk.aws_ecr.AuthorizationToken.grant_read( - grantee: IGrantable -) +AuthorizationToken.grantRead(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grantRead\` -\`\`\`python -import aws_cdk.aws_ecr +\`\`\`java +import software.amazon.awscdk.services.ecr.PublicGalleryAuthorizationToken; -aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( - grantee: IGrantable -) +PublicGalleryAuthorizationToken.grantRead(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`aws_cdk.core.IResource\`](#custom-aws_cdk.core.IResource) +- *Extends:* software.amazon.awscdk.core.IResource -- *Implemented By:* [\`aws_cdk.aws_ecr.Repository\`](#custom-aws_cdk.aws_ecr.Repository), [\`aws_cdk.aws_ecr.RepositoryBase\`](#custom-aws_cdk.aws_ecr.RepositoryBase), [\`aws_cdk.aws_ecr.IRepository\`](#custom-aws_cdk.aws_ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`addToResourcePolicy\` -\`\`\`python -def add_to_resource_policy( - statement: PolicyStatement -) +\`\`\`java +public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#custom-aws_cdk.aws_iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` -\`\`\`python -def grant( - grantee: IGrantable, - actions: str -) +\`\`\`java +public grant(IGrantable grantee, java.lang.String actions) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* java.lang.String --- -##### \`grant_pull\` +##### \`grantPull\` -\`\`\`python -def grant_pull( - grantee: IGrantable -) +\`\`\`java +public grantPull(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grantPullPush\` -\`\`\`python -def grant_pull_push( - grantee: IGrantable -) +\`\`\`java +public grantPullPush(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#custom-aws_cdk.aws_iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`onCloudTrailEvent\` -\`\`\`python -def on_cloud_trail_event( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None -) +\`\`\`java +public onCloudTrailEvent(java.lang.String id) +public onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -###### \`target\`Optional +###### \`options\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. +- *Type:* software.amazon.awscdk.services.events.OnEventOptions -The target to register for the event. +Options for adding the rule. --- -##### \`on_cloud_trail_image_pushed\` +##### \`onCloudTrailImagePushed\` -\`\`\`python -def on_cloud_trail_image_pushed( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tag: str = None -) +\`\`\`java +public onCloudTrailImagePushed(java.lang.String id) +public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- +###### \`options\`Optional -###### \`target\`Optional +- *Type:* OnCloudTrailImagePushedOptions -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -###### \`image_tag\`Optional - -- *Type:* \`str\` -- *Default:* Watch changes to all tags - -Only watch changes to this image tag. +Options for adding the rule. --- -##### \`on_event\` +##### \`onEvent\` -\`\`\`python -def on_event( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None -) +\`\`\`java +public onEvent(java.lang.String id) +public onEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required - -- *Type:* \`str\` - ---- - -###### \`description\`Optional - -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. +###### \`id\`Required -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +- *Type:* java.lang.String --- -###### \`rule_name\`Optional +###### \`options\`Optional -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. +- *Type:* software.amazon.awscdk.services.events.OnEventOptions --- -###### \`target\`Optional +##### \`onImageScanCompleted\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -##### \`on_image_scan_completed\` - -\`\`\`python -def on_image_scan_completed( - id: str, - description: str = None, - event_pattern: EventPattern = None, - rule_name: str = None, - target: IRuleTarget = None, - image_tags: typing.List[str] = None -) +\`\`\`java +public onImageScanCompleted(java.lang.String id) +public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* java.lang.String The id of the rule. --- -###### \`description\`Optional +###### \`options\`Optional -- *Type:* \`str\` -- *Default:* No description - -A description of the rule's purpose. +- *Type:* OnImageScanCompletedOptions ---- - -###### \`event_pattern\`Optional - -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#custom-aws_cdk.aws_events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -###### \`rule_name\`Optional - -- *Type:* \`str\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -###### \`target\`Optional - -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#custom-aws_cdk.aws_events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -###### \`image_tags\`Optional - -- *Type:* typing.List[\`str\`] -- *Default:* Watch the changes to the repository with all image tags - -Only watch changes to the image tags spedified. - -Leave it undefined to watch the full repository. +Options for adding the rule. --- -##### \`repository_uri_for_digest\` +##### \`repositoryUriForDigest\` -\`\`\`python -def repository_uri_for_digest( - digest: str = None -) +\`\`\`java +public repositoryUriForDigest() +public repositoryUriForDigest(java.lang.String digest) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repository_uri_for_tag\` +##### \`repositoryUriForTag\` -\`\`\`python -def repository_uri_for_tag( - tag: str = None -) +\`\`\`java +public repositoryUriForTag() +public repositoryUriForTag(java.lang.String tag) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* java.lang.String Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`aws_cdk.core.ConstructNode\`](#custom-aws_cdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`aws_cdk.core.ResourceEnvironment\`](#custom-aws_cdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`aws_cdk.core.Stack\`](#custom-aws_cdk.core.Stack) | The stack in which this resource is defined. | -| [\`repository_arn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| node | software.amazon.awscdk.core.ConstructNode | The construct tree node for this construct. | +| env | software.amazon.awscdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.core.Stack | The stack in which this resource is defined. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | +| repositoryUri | java.lang.String | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required -\`\`\`python -node: ConstructNode +\`\`\`java +public ConstructNode getNode(); \`\`\` -- *Type:* [\`aws_cdk.core.ConstructNode\`](#custom-aws_cdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required -\`\`\`python -env: ResourceEnvironment +\`\`\`java +public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`aws_cdk.core.ResourceEnvironment\`](#custom-aws_cdk.core.ResourceEnvironment) +- *Type:* software.amazon.awscdk.core.ResourceEnvironment The environment this resource belongs to. @@ -28398,49 +28105,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required -\`\`\`python -stack: Stack +\`\`\`java +public Stack getStack(); \`\`\` -- *Type:* [\`aws_cdk.core.Stack\`](#custom-aws_cdk.core.Stack) +- *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- -##### \`repository_arn\`Required +##### \`repositoryArn\`Required -\`\`\`python -repository_arn: str +\`\`\`java +public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repositoryName\`Required -\`\`\`python -repository_name: str +\`\`\`java +public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The name of the repository. --- -##### \`repository_uri\`Required +##### \`repositoryUri\`Required -\`\`\`python -repository_uri: str +\`\`\`java +public java.lang.String getRepositoryUri(); \`\`\` -- *Type:* \`str\` +- *Type:* java.lang.String The URI of this repository (represents the latest image):. @@ -28448,60 +28155,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#awscdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#awscdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#awscdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -28510,7 +28217,7 @@ Rule applies to untagged images. " `; -exports[`java for package 1`] = ` +exports[`java snapshot - root module 1`] = ` "# Amazon ECR Construct Library --- @@ -28565,10 +28272,10 @@ grants an IAM user access to call this API. \`\`\`java // Example automatically generated from non-compiling source. May contain errors. -import software.amazon.awscdk.services.iam.*; -import software.amazon.awscdk.services.ecr.*; +import aws.cdk.aws.iam.*; +import aws.cdk.aws.ecr.*; -User user = new User(this, \\"User\\", new UserProps()...); +Object user = User.Builder.create(this, \\"User\\")....build(); AuthorizationToken.grantRead(user); \`\`\` @@ -28581,10 +28288,10 @@ The following code snippet grants an IAM user access to retrieve an authorizatio \`\`\`java // Example automatically generated from non-compiling source. May contain errors. -import software.amazon.awscdk.services.iam.*; -import software.amazon.awscdk.services.ecr.*; +import aws.cdk.aws.iam.*; +import aws.cdk.aws.ecr.*; -User user = new User(this, \\"User\\", new UserProps()...); +Object user = User.Builder.create(this, \\"User\\")....build(); PublicGalleryAuthorizationToken.grantRead(user); \`\`\` @@ -28614,17 +28321,17 @@ repository.addLifecycleRule(Map.of(\\"maxImageAge\\", cdk.Duration.days(30))); \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.CfnPublicRepository; @@ -28639,34 +28346,34 @@ CfnPublicRepository.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`repositoryCatalogData\`Optional +##### \`repositoryCatalogData\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -28674,9 +28381,9 @@ scoped id of the resource. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -28684,9 +28391,9 @@ scoped id of the resource. --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -28694,9 +28401,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -28704,58 +28411,58 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -28763,13 +28470,13 @@ public TagManager getTags(); --- -##### \`repositoryCatalogData\`Required +##### \`repositoryCatalogData\`Required \`\`\`java public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -28777,13 +28484,13 @@ public java.lang.Object getRepositoryCatalogData(); --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`java public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -28791,13 +28498,13 @@ public java.lang.Object getRepositoryPolicyText(); --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -28805,31 +28512,35 @@ public java.lang.String getRepositoryName(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`java.lang.String\` +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` + +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.CfnRegistryPolicy; @@ -28841,31 +28552,31 @@ CfnRegistryPolicy.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnregistrypolicyparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnregistrypolicyparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropsparameterpolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`policyText\`Required +##### \`policyText\`Required -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -28873,55 +28584,55 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertyattrregistryid)* | \`java.lang.String\` | *No description.* | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| attrRegistryId | java.lang.String | *No description.* | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`java public java.lang.String getAttrRegistryId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`java public java.lang.Object getPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -28929,31 +28640,35 @@ public java.lang.Object getPolicyText(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration; @@ -28966,31 +28681,31 @@ CfnReplicationConfiguration.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropsparameterreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -28998,55 +28713,55 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertyattrregistryid)* | \`java.lang.String\` | *No description.* | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attrRegistryId | java.lang.String | *No description.* | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`java public java.lang.String getAttrRegistryId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`java public java.lang.Object getReplicationConfiguration(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -29054,31 +28769,35 @@ public java.lang.Object getReplicationConfiguration(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.CfnRepository; @@ -29097,37 +28816,37 @@ CfnRepository.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnrepositoryparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnrepositoryparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterencryptionconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterimagescanningconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterlifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::Repository.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::Repository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`encryptionConfiguration\`Optional +##### \`encryptionConfiguration\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -29135,9 +28854,9 @@ scoped id of the resource. --- -##### \`imageScanningConfiguration\`Optional +##### \`imageScanningConfiguration\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -29145,9 +28864,9 @@ scoped id of the resource. --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -29155,9 +28874,9 @@ scoped id of the resource. --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -29165,9 +28884,9 @@ scoped id of the resource. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -29175,9 +28894,9 @@ scoped id of the resource. --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -29185,9 +28904,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::Repository.Tags\`. @@ -29195,72 +28914,72 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrRepositoryUri\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyattrrepositoryuri)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyencryptionconfiguration)* | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyimagescanningconfiguration)* | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyrepositorypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropertylifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attrArn | java.lang.String | *No description.* | +| attrRepositoryUri | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrRepositoryUri\`Required +##### \`attrRepositoryUri\`Required \`\`\`java public java.lang.String getAttrRepositoryUri(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -29268,13 +28987,13 @@ public TagManager getTags(); --- -##### \`encryptionConfiguration\`Required +##### \`encryptionConfiguration\`Required \`\`\`java public java.lang.Object getEncryptionConfiguration(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -29282,13 +29001,13 @@ public java.lang.Object getEncryptionConfiguration(); --- -##### \`imageScanningConfiguration\`Required +##### \`imageScanningConfiguration\`Required \`\`\`java public java.lang.Object getImageScanningConfiguration(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -29296,13 +29015,13 @@ public java.lang.Object getImageScanningConfiguration(); --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`java public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -29310,13 +29029,13 @@ public java.lang.Object getRepositoryPolicyText(); --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`java public java.lang.String getImageTagMutability(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -29324,13 +29043,13 @@ public java.lang.String getImageTagMutability(); --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`java public java.lang.Object getLifecyclePolicy(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -29338,13 +29057,13 @@ public java.lang.Object getLifecyclePolicy(); --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -29352,27 +29071,31 @@ public java.lang.String getRepositoryName(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnrepositorypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.Repository; @@ -29389,41 +29112,41 @@ Repository.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrrepositoryparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesecrrepositoryparameterid)* | \`java.lang.String\` | *No description.* | -| [\`imageScanOnPush\`](#softwareamazonawscdkservicesecrrepositorypropsparameterimagescanonpush) | \`java.lang.Boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrrepositorypropsparameterimagetagmutability) | [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#softwareamazonawscdkservicesecrrepositorypropsparameterlifecycleregistryid) | \`java.lang.String\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#softwareamazonawscdkservicesecrrepositorypropsparameterlifecyclerules) | java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#softwareamazonawscdkservicesecrrepositorypropsparameterremovalpolicy) | [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropsparameterrepositoryname) | \`java.lang.String\` | Name for this repository. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| imageScanOnPush | java.lang.Boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | java.lang.String | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | java.util.List<LifecycleRule> | Life cycle rules to apply to this registry. | +| removalPolicy | software.amazon.awscdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | java.lang.String | Name for this repository. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`imageScanOnPush\`Optional +##### \`imageScanOnPush\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -29432,116 +29155,115 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycleRegistryId\`Optional +##### \`lifecycleRegistryId\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycleRules\`Optional +##### \`lifecycleRules\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> +- *Type:* java.util.List<LifecycleRule> - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removalPolicy\`Optional +##### \`removalPolicy\`Optional -- *Type:* [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) +- *Type:* software.amazon.awscdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name. Name for this repository. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addLifecycleRule\`](#softwareamazonawscdkservicesecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| addLifecycleRule | Add a life cycle rule to the repository. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`addLifecycleRule\` +##### \`addLifecycleRule\` \`\`\`java public addLifecycleRule(LifecycleRule rule) \`\`\` -###### \`rule\`Required +###### \`rule\`Required -- *Type:* [\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule) +- *Type:* LifecycleRule --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`java public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arnForLocalRepository\`](#softwareamazonawscdkservicesecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`fromRepositoryArn\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryarn) | *No description.* | -| [\`fromRepositoryAttributes\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`fromRepositoryName\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryname) | *No description.* | +| arnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| fromRepositoryArn | *No description.* | +| fromRepositoryAttributes | Import a repository. | +| fromRepositoryName | *No description.* | --- -##### \`arnForLocalRepository\` +##### \`arnForLocalRepository\` \`\`\`java import software.amazon.awscdk.services.ecr.Repository; -Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope) -Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope, java.lang.String account) +Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope),Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope, java.lang.String account) \`\`\` -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.IConstruct\`](#software.constructs.IConstruct) +- *Type:* software.constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`fromRepositoryArn\` +##### \`fromRepositoryArn\` \`\`\`java import software.amazon.awscdk.services.ecr.Repository; @@ -29549,25 +29271,25 @@ import software.amazon.awscdk.services.ecr.Repository; Repository.fromRepositoryArn(Construct scope, java.lang.String id, java.lang.String repositoryArn) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`repositoryArn\`Required +###### \`repositoryArn\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`fromRepositoryAttributes\` +##### \`fromRepositoryAttributes\` \`\`\`java import software.amazon.awscdk.services.ecr.Repository; @@ -29575,25 +29297,25 @@ import software.amazon.awscdk.services.ecr.Repository; Repository.fromRepositoryAttributes(Construct scope, java.lang.String id, RepositoryAttributes attrs) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`software.amazon.awscdk.services.ecr.RepositoryAttributes\`](#software.amazon.awscdk.services.ecr.RepositoryAttributes) +- *Type:* RepositoryAttributes --- -##### \`fromRepositoryName\` +##### \`fromRepositoryName\` \`\`\`java import software.amazon.awscdk.services.ecr.Repository; @@ -29601,67 +29323,67 @@ import software.amazon.awscdk.services.ecr.Repository; Repository.fromRepositoryName(Construct scope, java.lang.String id, java.lang.String repositoryName) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositorypropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`software.amazon.awscdk.services.ecr.IRepository\`](#software.amazon.awscdk.services.ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.ecr.RepositoryBase; @@ -29676,39 +29398,39 @@ RepositoryBase.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrrepositorybaseparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesecrrepositorybaseparameterid)* | \`java.lang.String\` | *No description.* | -| [\`account\`](#softwareamazonawscdkcoreresourcepropsparameteraccount) | \`java.lang.String\` | The AWS account ID this resource belongs to. | -| [\`environmentFromArn\`](#softwareamazonawscdkcoreresourcepropsparameterenvironmentfromarn) | \`java.lang.String\` | ARN to deduce region and account from. | -| [\`physicalName\`](#softwareamazonawscdkcoreresourcepropsparameterphysicalname) | \`java.lang.String\` | The value passed in by users to the physical name prop of the resource. | -| [\`region\`](#softwareamazonawscdkcoreresourcepropsparameterregion) | \`java.lang.String\` | The AWS region this resource belongs to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| account | java.lang.String | The AWS account ID this resource belongs to. | +| environmentFromArn | java.lang.String | ARN to deduce region and account from. | +| physicalName | java.lang.String | The value passed in by users to the physical name prop of the resource. | +| region | java.lang.String | The AWS region this resource belongs to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`account\`Optional +##### \`account\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* the resource is in the same account as the stack it belongs to The AWS account ID this resource belongs to. --- -##### \`environmentFromArn\`Optional +##### \`environmentFromArn\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. ARN to deduce region and account from. @@ -29717,9 +29439,9 @@ The ARN is parsed and the account and region are taken from the ARN. This should --- -##### \`physicalName\`Optional +##### \`physicalName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The physical name will be allocated by CloudFormation at deployment time The value passed in by users to the physical name prop of the resource. @@ -29728,246 +29450,246 @@ The value passed in by users to the physical name prop of the resource. --- -##### \`region\`Optional +##### \`region\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* the resource is in the same region as the stack it belongs to The AWS region this resource belongs to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#softwareamazonawscdkservicesecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#softwareamazonawscdkservicesecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grantPullPush\`](#softwareamazonawscdkservicesecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#softwareamazonawscdkservicesecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#softwareamazonawscdkservicesecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#softwareamazonawscdkservicesecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#softwareamazonawscdkservicesecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repositoryUriForDigest\`](#softwareamazonawscdkservicesecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#softwareamazonawscdkservicesecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to use the images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`java public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`java public grant(IGrantable grantee, java.lang.String actions) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`java public grantPull(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`java public grantPullPush(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`java public onCloudTrailEvent(java.lang.String id) public onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`java public onCloudTrailImagePushed(java.lang.String id) public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions\`](#software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`java public onEvent(java.lang.String id) public onEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`java public onImageScanCompleted(java.lang.String id) public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions\`](#software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`java public repositoryUriForDigest() public repositoryUriForDigest(java.lang.String digest) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Optional image digest. --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`java public repositoryUriForTag() public repositoryUriForTag(java.lang.String tag) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | -| [\`repositoryUri\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryuri)* | \`java.lang.String\` | The URI of this repository (represents the latest image):. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | +| repositoryUri | java.lang.String | The URI of this repository (represents the latest image):. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`java public java.lang.String getRepositoryUri(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URI of this repository (represents the latest image):. @@ -29976,15 +29698,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps; @@ -29997,24 +29719,24 @@ CfnPublicRepositoryProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repositoryCatalogData\`Optional +##### \`repositoryCatalogData\`Optional \`\`\`java public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -30022,13 +29744,13 @@ public java.lang.Object getRepositoryCatalogData(); --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -30036,13 +29758,13 @@ public java.lang.String getRepositoryName(); --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`java public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -30050,13 +29772,13 @@ public java.lang.Object getRepositoryPolicyText(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -30064,13 +29786,13 @@ public java.util.List getTags(); --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnRegistryPolicyProps; @@ -30080,21 +29802,21 @@ CfnRegistryPolicyProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropspropertypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policyText | java.lang.Object | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`java public java.lang.Object getPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -30102,13 +29824,13 @@ public java.lang.Object getPolicyText(); --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnReplicationConfigurationProps; @@ -30119,21 +29841,21 @@ CfnReplicationConfigurationProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replicationConfiguration | software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`java public java.lang.Object getReplicationConfiguration(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -30141,13 +29863,13 @@ public java.lang.Object getReplicationConfiguration(); --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnRepositoryProps; @@ -30164,27 +29886,27 @@ CfnRepositoryProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyencryptionconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyimagescanningconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertylifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | java.lang.Object | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | java.lang.Object | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | java.lang.String | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | java.lang.String | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryptionConfiguration\`Optional +##### \`encryptionConfiguration\`Optional \`\`\`java public java.lang.Object getEncryptionConfiguration(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -30192,13 +29914,13 @@ public java.lang.Object getEncryptionConfiguration(); --- -##### \`imageScanningConfiguration\`Optional +##### \`imageScanningConfiguration\`Optional \`\`\`java public java.lang.Object getImageScanningConfiguration(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -30206,13 +29928,13 @@ public java.lang.Object getImageScanningConfiguration(); --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`java public java.lang.String getImageTagMutability(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.ImageTagMutability\`. @@ -30220,13 +29942,13 @@ public java.lang.String getImageTagMutability(); --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`java public java.lang.Object getLifecyclePolicy(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* software.amazon.awscdk.core.IResolvable OR LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -30234,13 +29956,13 @@ public java.lang.Object getLifecyclePolicy(); --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::Repository.RepositoryName\`. @@ -30248,13 +29970,13 @@ public java.lang.String getRepositoryName(); --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`java public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -30262,13 +29984,13 @@ public java.lang.Object getRepositoryPolicyText(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::Repository.Tags\`. @@ -30276,11 +29998,11 @@ public java.util.List getTags(); --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty; @@ -30291,22 +30013,22 @@ LifecyclePolicyProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecyclePolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`java.lang.String\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registryId\`](#softwareamazonawscdkservicesecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`java.lang.String\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecyclePolicyText | java.lang.String | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registryId | java.lang.String | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecyclePolicyText\`Optional +##### \`lifecyclePolicyText\`Optional \`\`\`java public java.lang.String getLifecyclePolicyText(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -30314,13 +30036,13 @@ public java.lang.String getLifecyclePolicyText(); --- -##### \`registryId\`Optional +##### \`registryId\`Optional \`\`\`java public java.lang.String getRegistryId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -30328,11 +30050,11 @@ public java.lang.String getRegistryId(); --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.LifecycleRule; @@ -30347,39 +30069,39 @@ LifecycleRule.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecrlifecyclerulepropertydescription) | \`java.lang.String\` | Describes the purpose of the rule. | -| [\`maxImageAge\`](#softwareamazonawscdkservicesecrlifecyclerulepropertymaximageage) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`maxImageCount\`](#softwareamazonawscdkservicesecrlifecyclerulepropertymaximagecount) | \`java.lang.Number\` | The maximum number of images to retain. | -| [\`rulePriority\`](#softwareamazonawscdkservicesecrlifecyclerulepropertyrulepriority) | \`java.lang.Number\` | Controls the order in which rules are evaluated (low to high). | -| [\`tagPrefixList\`](#softwareamazonawscdkservicesecrlifecyclerulepropertytagprefixlist) | java.util.List<\`java.lang.String\`> | Select images that have ALL the given prefixes in their tag. | -| [\`tagStatus\`](#softwareamazonawscdkservicesecrlifecyclerulepropertytagstatus) | [\`software.amazon.awscdk.services.ecr.TagStatus\`](#software.amazon.awscdk.services.ecr.TagStatus) | Select images based on tags. | +| description | java.lang.String | Describes the purpose of the rule. | +| maxImageAge | software.amazon.awscdk.core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| maxImageCount | java.lang.Number | The maximum number of images to retain. | +| rulePriority | java.lang.Number | Controls the order in which rules are evaluated (low to high). | +| tagPrefixList | java.util.List | Select images that have ALL the given prefixes in their tag. | +| tagStatus | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`java public java.lang.String getDescription(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No description Describes the purpose of the rule. --- -##### \`maxImageAge\`Optional +##### \`maxImageAge\`Optional \`\`\`java public Duration getMaxImageAge(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -30387,13 +30109,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`maxImageCount\`Optional +##### \`maxImageCount\`Optional \`\`\`java public java.lang.Number getMaxImageCount(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number The maximum number of images to retain. @@ -30401,13 +30123,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rulePriority\`Optional +##### \`rulePriority\`Optional \`\`\`java public java.lang.Number getRulePriority(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -30416,13 +30138,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tagPrefixList\`Optional +##### \`tagPrefixList\`Optional \`\`\`java public java.util.List getTagPrefixList(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List Select images that have ALL the given prefixes in their tag. @@ -30430,13 +30152,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tagStatus\`Optional +##### \`tagStatus\`Optional \`\`\`java public TagStatus getTagStatus(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ecr.TagStatus\`](#software.amazon.awscdk.services.ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -30445,11 +30167,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions; @@ -30463,92 +30185,92 @@ OnCloudTrailImagePushedOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertydescription) | \`java.lang.String\` | A description of the rule's purpose. | -| [\`eventPattern\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyrulename) | \`java.lang.String\` | A name for the rule. | -| [\`target\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertytarget) | [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) | The target to register for the event. | -| [\`imageTag\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyimagetag) | \`java.lang.String\` | Only watch changes to this image tag. | +| description | java.lang.String | A description of the rule's purpose. | +| eventPattern | software.amazon.awscdk.services.events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | java.lang.String | A name for the rule. | +| target | software.amazon.awscdk.services.events.IRuleTarget | The target to register for the event. | +| imageTag | java.lang.String | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`java public java.lang.String getDescription(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`java public EventPattern getEventPattern(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) +- *Type:* software.amazon.awscdk.services.events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`java public java.lang.String getRuleName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`java public IRuleTarget getTarget(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) +- *Type:* software.amazon.awscdk.services.events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTag\`Optional +##### \`imageTag\`Optional \`\`\`java public java.lang.String getImageTag(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions; @@ -30562,81 +30284,81 @@ OnImageScanCompletedOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertydescription) | \`java.lang.String\` | A description of the rule's purpose. | -| [\`eventPattern\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyeventpattern) | [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyrulename) | \`java.lang.String\` | A name for the rule. | -| [\`target\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertytarget) | [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) | The target to register for the event. | -| [\`imageTags\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyimagetags) | java.util.List<\`java.lang.String\`> | Only watch changes to the image tags spedified. | +| description | java.lang.String | A description of the rule's purpose. | +| eventPattern | software.amazon.awscdk.services.events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | java.lang.String | A name for the rule. | +| target | software.amazon.awscdk.services.events.IRuleTarget | The target to register for the event. | +| imageTags | java.util.List | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`java public java.lang.String getDescription(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`java public EventPattern getEventPattern(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) +- *Type:* software.amazon.awscdk.services.events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`java public java.lang.String getRuleName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`java public IRuleTarget getTarget(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) +- *Type:* software.amazon.awscdk.services.events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTags\`Optional +##### \`imageTags\`Optional \`\`\`java public java.util.List getImageTags(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -30645,11 +30367,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty; @@ -30661,21 +30383,21 @@ ReplicationConfigurationProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty)> | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationRuleProperty> | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required \`\`\`java public java.lang.Object getRules(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationRuleProperty> \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -30683,11 +30405,11 @@ public java.lang.Object getRules(); --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty; @@ -30698,22 +30420,22 @@ ReplicationDestinationProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`java.lang.String\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registryId\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`java.lang.String\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | java.lang.String | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registryId | java.lang.String | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required \`\`\`java public java.lang.String getRegion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -30721,13 +30443,13 @@ public java.lang.String getRegion(); --- -##### \`registryId\`Required +##### \`registryId\`Required \`\`\`java public java.lang.String getRegistryId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -30735,11 +30457,11 @@ public java.lang.String getRegistryId(); --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty; @@ -30751,21 +30473,21 @@ ReplicationRuleProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)> | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationDestinationProperty> | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required \`\`\`java public java.lang.Object getDestinations(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.ListReplicationDestinationProperty> \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -30773,9 +30495,9 @@ public java.lang.Object getDestinations(); --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.RepositoryAttributes; @@ -30786,38 +30508,38 @@ RepositoryAttributes.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositoryattributespropertyrepositoryarn)* | \`java.lang.String\` | *No description.* | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositoryattributespropertyrepositoryname)* | \`java.lang.String\` | *No description.* | +| repositoryArn | java.lang.String | *No description.* | +| repositoryName | java.lang.String | *No description.* | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.ecr.RepositoryProps; @@ -30832,39 +30554,39 @@ RepositoryProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`imageScanOnPush\`](#softwareamazonawscdkservicesecrrepositorypropspropertyimagescanonpush) | \`java.lang.Boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrrepositorypropspropertyimagetagmutability) | [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#softwareamazonawscdkservicesecrrepositorypropspropertylifecycleregistryid) | \`java.lang.String\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#softwareamazonawscdkservicesecrrepositorypropspropertylifecyclerules) | java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#softwareamazonawscdkservicesecrrepositorypropspropertyremovalpolicy) | [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropspropertyrepositoryname) | \`java.lang.String\` | Name for this repository. | +| imageScanOnPush | java.lang.Boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | java.lang.String | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | java.util.List<LifecycleRule> | Life cycle rules to apply to this registry. | +| removalPolicy | software.amazon.awscdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | java.lang.String | Name for this repository. | --- -##### \`imageScanOnPush\`Optional +##### \`imageScanOnPush\`Optional \`\`\`java public java.lang.Boolean getImageScanOnPush(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`java public TagMutability getImageTagMutability(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -30873,78 +30595,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycleRegistryId\`Optional +##### \`lifecycleRegistryId\`Optional \`\`\`java public java.lang.String getLifecycleRegistryId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycleRules\`Optional +##### \`lifecycleRules\`Optional \`\`\`java public java.util.List getLifecycleRules(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> +- *Type:* java.util.List<LifecycleRule> - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removalPolicy\`Optional +##### \`removalPolicy\`Optional \`\`\`java public RemovalPolicy getRemovalPolicy(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) +- *Type:* software.amazon.awscdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#softwareamazonawscdkservicesecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`java import software.amazon.awscdk.services.ecr.AuthorizationToken; @@ -30952,30 +30674,30 @@ import software.amazon.awscdk.services.ecr.AuthorizationToken; AuthorizationToken.grantRead(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#softwareamazonawscdkservicesecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`java import software.amazon.awscdk.services.ecr.PublicGalleryAuthorizationToken; @@ -30983,245 +30705,245 @@ import software.amazon.awscdk.services.ecr.PublicGalleryAuthorizationToken; PublicGalleryAuthorizationToken.grantRead(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`software.amazon.awscdk.core.IResource\`](#software.amazon.awscdk.core.IResource) +- *Extends:* software.amazon.awscdk.core.IResource -- *Implemented By:* [\`software.amazon.awscdk.services.ecr.Repository\`](#software.amazon.awscdk.services.ecr.Repository), [\`software.amazon.awscdk.services.ecr.RepositoryBase\`](#software.amazon.awscdk.services.ecr.RepositoryBase), [\`software.amazon.awscdk.services.ecr.IRepository\`](#software.amazon.awscdk.services.ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#softwareamazonawscdkservicesecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#softwareamazonawscdkservicesecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#softwareamazonawscdkservicesecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#softwareamazonawscdkservicesecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#softwareamazonawscdkservicesecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`java public addToResourcePolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`java public grant(IGrantable grantee, java.lang.String actions) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`java public grantPull(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`java public grantPullPush(IGrantable grantee) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`java public onCloudTrailEvent(java.lang.String id) public onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`java public onCloudTrailImagePushed(java.lang.String id) public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions\`](#software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`java public onEvent(java.lang.String id) public onEvent(java.lang.String id, OnEventOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`java public onImageScanCompleted(java.lang.String id) public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions\`](#software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`java public repositoryUriForDigest() public repositoryUriForDigest(java.lang.String digest) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`java public repositoryUriForTag() public repositoryUriForTag(java.lang.String tag) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkservicesecrirepositorypropertynode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#softwareamazonawscdkservicesecrirepositorypropertyenv)* | [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkservicesecrirepositorypropertystack)* | [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | -| [\`repositoryUri\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryuri)* | \`java.lang.String\` | The URI of this repository (represents the latest image):. | +| node | software.amazon.awscdk.core.ConstructNode | The construct tree node for this construct. | +| env | software.amazon.awscdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.core.Stack | The stack in which this resource is defined. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | +| repositoryUri | java.lang.String | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`java public ConstructNode getNode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) +- *Type:* software.amazon.awscdk.core.ResourceEnvironment The environment this resource belongs to. @@ -31229,49 +30951,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) +- *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`java public java.lang.String getRepositoryUri(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URI of this repository (represents the latest image):. @@ -31279,60 +31001,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#softwareamazonawscdkservicesecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#softwareamazonawscdkservicesecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#softwareamazonawscdkservicesecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -31341,3325 +31063,494 @@ Rule applies to untagged images. " `; -exports[`java snapshot - root module 1`] = ` -"# Amazon ECR Construct Library - ---- +exports[`java snapshot - submodules 1`] = ` +"# Amazon EKS Construct Library + +--- ![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) ![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge) --- + -This package contains constructs for working with Amazon Elastic Container Registry. +This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. +In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. -## Repositories +## Table Of Contents -Define a repository by creating a new instance of \`Repository\`. A repository -holds multiple verions of a single container image. +* [Quick Start](#quick-start) +* [API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-eks-readme.html) +* [Architectural Overview](#architectural-overview) +* [Provisioning clusters](#provisioning-clusters) + * [Managed node groups](#managed-node-groups) + * [Fargate Profiles](#fargate-profiles) + * [Self-managed nodes](#self-managed-nodes) + * [Endpoint Access](#endpoint-access) + * [VPC Support](#vpc-support) + * [Kubectl Support](#kubectl-support) + * [ARM64 Support](#arm64-support) + * [Masters Role](#masters-role) + * [Encryption](#encryption) +* [Permissions and Security](#permissions-and-security) +* [Applying Kubernetes Resources](#applying-kubernetes-resources) + * [Kubernetes Manifests](#kubernetes-manifests) + * [Helm Charts](#helm-charts) + * [CDK8s Charts](#cdk8s-charts) +* [Patching Kubernetes Resources](#patching-kubernetes-resources) +* [Querying Kubernetes Resources](#querying-kubernetes-resources) +* [Using existing clusters](#using-existing-clusters) +* [Known Issues and Limitations](#known-issues-and-limitations) -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -Object repository = new Repository(this, \\"Repository\\"); -\`\`\` +## Quick Start -## Image scanning +This example defines an Amazon EKS cluster with the following configuration: -Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable \`imageScanOnPush\` in the properties +* Dedicated VPC with default configuration (Implicitly created using [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) +* A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -Object repository = Repository.Builder.create(stack, \\"Repo\\") - .imageScanOnPush(true) - .build(); +\`\`\`ts +// provisiong a cluster +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_19, +}); + +// apply a kubernetes manifest to the cluster +cluster.addManifest('mypod', { + apiVersion: 'v1', + kind: 'Pod', + metadata: { name: 'mypod' }, + spec: { + containers: [ + { + name: 'hello', + image: 'paulbouwer/hello-kubernetes:1.5', + ports: [ { containerPort: 8080 } ] + } + ] + } +}); \`\`\` -To create an \`onImageScanCompleted\` event rule and trigger the event target +In order to interact with your cluster through \`kubectl\`, you can use the \`aws eks update-kubeconfig\` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) +to configure your local kubeconfig. The EKS module will define a CloudFormation output in your stack which contains the command to run. For example: -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -repository.onImageScanCompleted(\\"ImageScanComplete\\").addTarget(...); +\`\`\`plaintext +Outputs: +ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy \`\`\` -### Authorization Token - -Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull -images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and -additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests. -More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth). +Execute the \`aws eks update-kubeconfig ...\` command in your terminal to create or update a local kubeconfig context: -A Docker authorization token can be obtained using the \`GetAuthorizationToken\` ECR API. The following code snippets -grants an IAM user access to call this API. +\`\`\`console +$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy +Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config +\`\`\` -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -import aws.cdk.aws.iam.*; -import aws.cdk.aws.ecr.*; +And now you can simply use \`kubectl\`: -Object user = User.Builder.create(this, \\"User\\")....build(); -AuthorizationToken.grantRead(user); +\`\`\`console +$ kubectl get all -n kube-system +NAME READY STATUS RESTARTS AGE +pod/aws-node-fpmwv 1/1 Running 0 21m +pod/aws-node-m9htf 1/1 Running 0 21m +pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m +pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m +... \`\`\` -If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from -higher rate and bandwidth limits. +## Architectural Overview -> See \`Pricing\` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html). +The following is a qualitative diagram of the various possible components involved in the cluster deployment. -The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery. +\`\`\`text + +-----------------------------------------------+ +-----------------+ + | EKS Cluster | kubectl | | + |-----------------------------------------------|<-------------+| Kubectl Handler | + | | | | + | | +-----------------+ + | +--------------------+ +-----------------+ | + | | | | | | + | | Managed Node Group | | Fargate Profile | | +-----------------+ + | | | | | | | | + | +--------------------+ +-----------------+ | | Cluster Handler | + | | | | + +-----------------------------------------------+ +-----------------+ + ^ ^ + + | | | + | connect self managed capacity | | aws-sdk + | | create/update/delete | + + | v + +--------------------+ + +-------------------+ + | | --------------+| eks.amazonaws.com | + | Auto Scaling Group | +-------------------+ + | | + +--------------------+ +\`\`\` -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -import aws.cdk.aws.iam.*; -import aws.cdk.aws.ecr.*; +In a nutshell: -Object user = User.Builder.create(this, \\"User\\")....build(); -PublicGalleryAuthorizationToken.grantRead(user); -\`\`\` +* \`EKS Cluster\` - The cluster endpoint created by EKS. +* \`Managed Node Group\` - EC2 worker nodes managed by EKS. +* \`Fargate Profile\` - Fargate worker nodes managed by EKS. +* \`Auto Scaling Group\` - EC2 worker nodes managed by the user. +* \`KubectlHandler\` - Lambda function for invoking \`kubectl\` commands on the cluster - created by CDK. +* \`ClusterHandler\` - Lambda function for interacting with EKS API to manage the cluster lifecycle - created by CDK. -This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth). +A more detailed breakdown of each is provided further down this README. -### Image tag immutability +## Provisioning clusters -You can set tag immutability on images in our repository using the \`imageTagMutability\` construct prop. +Creating a new cluster is done using the \`Cluster\` or \`FargateCluster\` constructs. The only required property is the kubernetes \`version\`. -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -Repository.Builder.create(stack, \\"Repo\\").imageTagMutability(ecr.getTagMutability().getIMMUTABLE()).build(); +\`\`\`ts +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, +}); \`\`\` -## Automatically clean up repositories - -You can set life cycle rules to automatically clean up old images from your -repository. The first life cycle rule that matches an image will be applied -against that image. For example, the following deletes images older than -30 days, while keeping all images tagged with prod (note that the order -is important here): +You can also use \`FargateCluster\` to provision a cluster that uses only fargate workers. -\`\`\`java -// Example automatically generated from non-compiling source. May contain errors. -repository.addLifecycleRule(Map.of(\\"tagPrefixList\\", List.of(\\"prod\\"), \\"maxImageCount\\", 9999)); -repository.addLifecycleRule(Map.of(\\"maxImageAge\\", cdk.Duration.days(30))); +\`\`\`ts +new eks.FargateCluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, +}); \`\`\` -# API Reference - -## Constructs -### CfnPublicRepository +> **NOTE: Only 1 cluster per stack is supported.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see . -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +Below you'll find a few important cluster configuration options. First of which is Capacity. +Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity, which you can combine as you like: -A CloudFormation \`AWS::ECR::PublicRepository\`. +### Managed node groups -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) +Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. +With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. -#### Initializers +> For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnPublicRepository; +**Managed Node Groups are the recommended way to allocate cluster capacity.** -CfnPublicRepository.Builder.create(Construct scope, java.lang.String id) -// .repositoryCatalogData(java.lang.Object) -// .repositoryName(java.lang.String) -// .repositoryPolicyText(java.lang.Object) -// .tags(java.util.List) - .build(); -\`\`\` +By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | +At cluster instantiation time, you can customize the number of instances and their type: ---- +\`\`\`ts +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, + defaultCapacity: 5, + defaultCapacityInstance: ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.SMALL), +}); +\`\`\` -##### \`scope\`Required +To access the node group that was created on your behalf, you can use \`cluster.defaultNodegroup\`. -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +Additional customizations are available post instantiation. To apply them, set the default capacity to 0, and use the \`cluster.addNodegroupCapacity\` method: -scope in which this resource is defined. +\`\`\`ts +const cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, + defaultCapacity: 0, +}); ---- +cluster.addNodegroupCapacity('custom-node-group', { + instanceTypes: [new ec2.InstanceType('m5.large')], + minSize: 4, + diskSize: 100, + amiType: eks.NodegroupAmiType.AL2_X86_64_GPU, + ... +}); +\`\`\` -##### \`id\`Required +#### Spot Instances Support -- *Type:* \`java.lang.String\` +Use \`capacityType\` to create managed node groups comprised of spot instances. To maximize the availability of your applications while using +Spot Instances, we recommend that you configure a Spot managed node group to use multiple instance types with the \`instanceTypes\` property. -scoped id of the resource. +> For more details visit [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types). ---- -##### \`repositoryCatalogData\`Optional +\`\`\`ts +cluster.addNodegroupCapacity('extra-ng-spot', { + instanceTypes: [ + new ec2.InstanceType('c5.large'), + new ec2.InstanceType('c5a.large'), + new ec2.InstanceType('c5d.large'), + ], + minSize: 3, + capacityType: eks.CapacityType.SPOT, +}); -- *Type:* \`java.lang.Object\` +\`\`\` -\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. +#### Launch Template Support -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) +You can specify a launch template that the node group will use. For example, this can be useful if you want to use +a custom AMI or add custom user data. ---- +When supplying a custom user data script, it must be encoded in the MIME multi-part archive format, since Amazon EKS merges with its own user data. Visit the [Launch Template Docs](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) +for mode details. -##### \`repositoryName\`Optional +\`\`\`ts +const userData = \`MIME-Version: 1.0 +Content-Type: multipart/mixed; boundary=\\"==MYBOUNDARY==\\" -- *Type:* \`java.lang.String\` +--==MYBOUNDARY== +Content-Type: text/x-shellscript; charset=\\"us-ascii\\" -\`AWS::ECR::PublicRepository.RepositoryName\`. +#!/bin/bash +echo \\"Running custom user data script\\" -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) +--==MYBOUNDARY==--\\\\\\\\ +\`; +const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { + launchTemplateData: { + instanceType: 't3.small', + userData: Fn.base64(userData), + }, +}); +cluster.addNodegroupCapacity('extra-ng', { + launchTemplateSpec: { + id: lt.ref, + version: lt.attrLatestVersionNumber, + }, +}); ---- +\`\`\` -##### \`repositoryPolicyText\`Optional +Note that when using a custom AMI, Amazon EKS doesn't merge any user data. Which means you do not need the multi-part encoding. and are responsible for supplying the required bootstrap commands for nodes to join the cluster. +In the following example, \`/ect/eks/bootstrap.sh\` from the AMI will be used to bootstrap the node. -- *Type:* \`java.lang.Object\` +\`\`\`ts +const userData = ec2.UserData.forLinux(); +userData.addCommands( + 'set -o xtrace', + \`/etc/eks/bootstrap.sh \${cluster.clusterName}\`, +); +const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { + launchTemplateData: { + imageId: 'some-ami-id', // custom AMI + instanceType: 't3.small', + userData: Fn.base64(userData.render()), + }, +}); +cluster.addNodegroupCapacity('extra-ng', { + launchTemplateSpec: { + id: lt.ref, + version: lt.attrLatestVersionNumber, + }, +}); +\`\`\` -\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. +You may specify one \`instanceType\` in the launch template or multiple \`instanceTypes\` in the node group, **but not both**. -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) +> For more details visit [Launch Template Support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html). ---- +Graviton 2 instance types are supported including \`c6g\`, \`m6g\`, \`r6g\` and \`t4g\`. -##### \`tags\`Optional +### Fargate profiles -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +AWS Fargate is a technology that provides on-demand, right-sized compute +capacity for containers. With AWS Fargate, you no longer have to provision, +configure, or scale groups of virtual machines to run containers. This removes +the need to choose server types, decide when to scale your node groups, or +optimize cluster packing. -\`AWS::ECR::PublicRepository.Tags\`. +You can control which pods start on Fargate and how they run with Fargate +Profiles, which are defined as part of your Amazon EKS cluster. -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) +See [Fargate Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) in the AWS EKS User Guide. ---- +You can add Fargate Profiles to any EKS cluster defined in your CDK app +through the \`addFargateProfile()\` method. The following example adds a profile +that will match all pods from the \\"default\\" namespace: -#### Methods +\`\`\`ts +cluster.addFargateProfile('MyProfile', { + selectors: [ { namespace: 'default' } ] +}); +\`\`\` -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +You can also directly use the \`FargateProfile\` construct to create profiles under different scopes: ---- +\`\`\`ts +new eks.FargateProfile(scope, 'MyProfile', { + cluster, + ... +}); +\`\`\` -##### \`inspect\` +To create an EKS cluster that **only** uses Fargate capacity, you can use \`FargateCluster\`. +The following code defines an Amazon EKS cluster with a default Fargate Profile that matches all pods from the \\"kube-system\\" and \\"default\\" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns). -\`\`\`java -public inspect(TreeInspector inspector) +\`\`\`ts +const cluster = new eks.FargateCluster(this, 'MyCluster', { + version: eks.KubernetesVersion.V1_19, +}); \`\`\` -###### \`inspector\`Required +**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on +pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress +Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) +on Amazon EKS (minimum version v1.1.4). -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +### Self-managed nodes -tree inspector to collect and process attributes. +Another way of allocating capacity to an EKS cluster is by using self-managed nodes. +EC2 instances that are part of the auto-scaling group will serve as worker nodes for the cluster. +This type of capacity is also commonly referred to as *EC2 Capacity** or *EC2 Nodes*. ---- +For a detailed overview please visit [Self Managed Nodes](https://docs.aws.amazon.com/eks/latest/userguide/worker.html). +Creating an auto-scaling group and connecting it to the cluster is done using the \`cluster.addAutoScalingGroupCapacity\` method: -#### Properties +\`\`\`ts +cluster.addAutoScalingGroupCapacity('frontend-nodes', { + instanceType: new ec2.InstanceType('t2.medium'), + minCapacity: 3, + vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } +}); +\`\`\` -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +To connect an already initialized auto-scaling group, use the \`cluster.connectAutoScalingGroupCapacity()\` method: ---- +\`\`\`ts +const asg = new ec2.AutoScalingGroup(...); +cluster.connectAutoScalingGroupCapacity(asg); +\`\`\` -##### \`attrArn\`Required +In both cases, the [cluster security group](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html#cluster-sg) will be automatically attached to +the auto-scaling group, allowing for traffic to flow freely between managed and self-managed nodes. -\`\`\`java -public java.lang.String getAttrArn(); -\`\`\` +> **Note:** The default \`updateType\` for auto-scaling groups does not replace existing nodes. Since security groups are determined at launch time, self-managed nodes that were provisioned with version \`1.78.0\` or lower, will not be updated. +> To apply the new configuration on all your self-managed nodes, you'll need to replace the nodes using the \`UpdateType.REPLACING_UPDATE\` policy for the [\`updateType\`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-autoscaling.AutoScalingGroup.html#updatetypespan-classapi-icon-api-icon-deprecated-titlethis-api-element-is-deprecated-its-use-is-not-recommended%EF%B8%8Fspan) property. -- *Type:* \`java.lang.String\` +You can customize the [/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) script, which is responsible +for bootstrapping the node to the EKS cluster. For example, you can use \`kubeletExtraArgs\` to add custom node labels or taints. ---- +\`\`\`ts +cluster.addAutoScalingGroupCapacity('spot', { + instanceType: new ec2.InstanceType('t3.large'), + minCapacity: 2, + bootstrapOptions: { + kubeletExtraArgs: '--node-labels foo=bar,goo=far', + awsApiRetryAttempts: 5 + } +}); +\`\`\` -##### \`tags\`Required +To disable bootstrapping altogether (i.e. to fully customize user-data), set \`bootstrapEnabled\` to \`false\`. +You can also configure the cluster to use an auto-scaling group as the default capacity: -\`\`\`java -public TagManager getTags(); +\`\`\`ts +cluster = new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, + defaultCapacityType: eks.DefaultCapacityType.EC2, +}); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +This will allocate an auto-scaling group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). +To access the \`AutoScalingGroup\` that was created on your behalf, you can use \`cluster.defaultCapacity\`. +You can also independently create an \`AutoScalingGroup\` and connect it to the cluster using the \`cluster.connectAutoScalingGroupCapacity\` method: -\`AWS::ECR::PublicRepository.Tags\`. +\`\`\`ts +const asg = new ec2.AutoScalingGroup(...) +cluster.connectAutoScalingGroupCapacity(asg); +\`\`\` -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) +This will add the necessary user-data to access the apiserver and configure all connections, roles, and tags needed for the instances in the auto-scaling group to properly join the cluster. ---- +#### Spot Instances -##### \`repositoryCatalogData\`Required +When using self-managed nodes, you can configure the capacity to use spot instances, greatly reducing capacity cost. +To enable spot capacity, use the \`spotPrice\` property: -\`\`\`java -public java.lang.Object getRepositoryCatalogData(); +\`\`\`ts +cluster.addAutoScalingGroupCapacity('spot', { + spotPrice: '0.1094', + instanceType: new ec2.InstanceType('t3.large'), + maxCapacity: 10 +}); \`\`\` -- *Type:* \`java.lang.Object\` +> Spot instance nodes will be labeled with \`lifecycle=Ec2Spot\` and tainted with \`PreferNoSchedule\`. -\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. +The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) \`DaemonSet\` will be +installed from [Amazon EKS Helm chart repository](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. +The termination handler ensures that the Kubernetes control plane responds appropriately to events that +can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) +and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be +terminated. -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) +> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) +> +> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) ---- +To disable the installation of the termination handler, set the \`spotInterruptHandler\` property to \`false\`. This applies both to \`addAutoScalingGroupCapacity\` and \`connectAutoScalingGroupCapacity\`. -##### \`repositoryPolicyText\`Required +#### Bottlerocket -\`\`\`java -public java.lang.Object getRepositoryPolicyText(); -\`\`\` +[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. +At this moment, \`Bottlerocket\` is only supported when using self-managed auto-scaling groups. -- *Type:* \`java.lang.Object\` +> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). -\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. +The following example will create an auto-scaling group of 2 \`t3.small\` Linux instances running with the \`Bottlerocket\` AMI. -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) +\`\`\`ts +cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { + instanceType: new ec2.InstanceType('t3.small'), + minCapacity: 2, + machineImageType: eks.MachineImageType.BOTTLEROCKET +}); +\`\`\` ---- +The specific Bottlerocket AMI variant will be auto selected according to the k8s version for the \`x86_64\` architecture. +For example, if the Amazon EKS cluster version is \`1.17\`, the Bottlerocket AMI variant will be auto selected as +\`aws-k8s-1.17\` behind the scene. -##### \`repositoryName\`Optional +> See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` +Please note Bottlerocket does not allow to customize bootstrap options and \`bootstrapOptions\` properties is not supported when you create the \`Bottlerocket\` capacity. -- *Type:* \`java.lang.String\` +### Endpoint Access -\`AWS::ECR::PublicRepository.RepositoryName\`. +When you create a new cluster, Amazon EKS creates an endpoint for the managed Kubernetes API server that you use to communicate with your cluster (using Kubernetes management tools such as \`kubectl\`) -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) +By default, this API server endpoint is public to the internet, and access to the API server is secured using a combination of +AWS Identity and Access Management (IAM) and native Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC). ---- +You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the \`endpointAccess\` property: -#### Constants +\`\`\`ts +const cluster = new eks.Cluster(this, 'hello-eks', { + version: eks.KubernetesVersion.V1_19, + endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. +}); +\`\`\` -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +The default value is \`eks.EndpointAccess.PUBLIC_AND_PRIVATE\`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic and \`kubectl\` commands issued by this library stay within your VPC. ---- +### VPC Support -##### \`CFN_RESOURCE_TYPE_NAME\` +You can specify the VPC of the cluster using the \`vpc\` and \`vpcSubnets\` properties: -- *Type:* \`java.lang.String\` +\`\`\`ts +const vpc = new ec2.Vpc(this, 'Vpc'); -The CloudFormation resource type name for this resource class. +new eks.Cluster(this, 'HelloEKS', { + version: eks.KubernetesVersion.V1_19, + vpc, + vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE }] +}); +\`\`\` ---- +> Note: Isolated VPCs (i.e with no internet access) are not currently supported. See https://github.com/aws/aws-cdk/issues/12171 -### CfnRegistryPolicy - -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) - -A CloudFormation \`AWS::ECR::RegistryPolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) - -#### Initializers - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnRegistryPolicy; - -CfnRegistryPolicy.Builder.create(Construct scope, java.lang.String id) - .policyText(java.lang.Object) - .build(); -\`\`\` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnregistrypolicyparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnregistrypolicyparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropsparameterpolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) - -scope in which this resource is defined. - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - -scoped id of the resource. - ---- - -##### \`policyText\`Required - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::RegistryPolicy.PolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | - ---- - -##### \`inspect\` - -\`\`\`java -public inspect(TreeInspector inspector) -\`\`\` - -###### \`inspector\`Required - -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) - -tree inspector to collect and process attributes. - ---- - - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`attrRegistryId\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertyattrregistryid)* | \`java.lang.String\` | *No description.* | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`attrRegistryId\`Required - -\`\`\`java -public java.lang.String getAttrRegistryId(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -##### \`policyText\`Required - -\`\`\`java -public java.lang.Object getPolicyText(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::RegistryPolicy.PolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`java.lang.String\` - -The CloudFormation resource type name for this resource class. - ---- - -### CfnReplicationConfiguration - -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) - -A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) - -#### Initializers - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration; - -CfnReplicationConfiguration.Builder.create(Construct scope, java.lang.String id) - .replicationConfiguration(IResolvable) - .replicationConfiguration(ReplicationConfigurationProperty) - .build(); -\`\`\` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropsparameterreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) - -scope in which this resource is defined. - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - -scoped id of the resource. - ---- - -##### \`replicationConfiguration\`Required - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) - -\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | - ---- - -##### \`inspect\` - -\`\`\`java -public inspect(TreeInspector inspector) -\`\`\` - -###### \`inspector\`Required - -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) - -tree inspector to collect and process attributes. - ---- - - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`attrRegistryId\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertyattrregistryid)* | \`java.lang.String\` | *No description.* | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | - ---- - -##### \`attrRegistryId\`Required - -\`\`\`java -public java.lang.String getAttrRegistryId(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -##### \`replicationConfiguration\`Required - -\`\`\`java -public java.lang.Object getReplicationConfiguration(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) - -\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`java.lang.String\` - -The CloudFormation resource type name for this resource class. - ---- - -### CfnRepository - -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) - -A CloudFormation \`AWS::ECR::Repository\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) - -#### Initializers - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnRepository; - -CfnRepository.Builder.create(Construct scope, java.lang.String id) -// .encryptionConfiguration(java.lang.Object) -// .imageScanningConfiguration(java.lang.Object) -// .imageTagMutability(java.lang.String) -// .lifecyclePolicy(IResolvable) -// .lifecyclePolicy(LifecyclePolicyProperty) -// .repositoryName(java.lang.String) -// .repositoryPolicyText(java.lang.Object) -// .tags(java.util.List) - .build(); -\`\`\` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnrepositoryparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnrepositoryparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterencryptionconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterimagescanningconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterlifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparameterrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::Repository.Tags\`. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) - -scope in which this resource is defined. - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - -scoped id of the resource. - ---- - -##### \`encryptionConfiguration\`Optional - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.EncryptionConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) - ---- - -##### \`imageScanningConfiguration\`Optional - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.ImageScanningConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) - ---- - -##### \`imageTagMutability\`Optional - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.ImageTagMutability\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) - ---- - -##### \`lifecyclePolicy\`Optional - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) - -\`AWS::ECR::Repository.LifecyclePolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) - ---- - -##### \`repositoryName\`Optional - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) - ---- - -##### \`repositoryPolicyText\`Optional - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) - ---- - -##### \`tags\`Optional - -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> - -\`AWS::ECR::Repository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | - ---- - -##### \`inspect\` - -\`\`\`java -public inspect(TreeInspector inspector) -\`\`\` - -###### \`inspector\`Required - -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) - -tree inspector to collect and process attributes. - ---- - - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrRepositoryUri\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyattrrepositoryuri)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyencryptionconfiguration)* | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyimagescanningconfiguration)* | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyrepositorypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropertylifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | - ---- - -##### \`attrArn\`Required - -\`\`\`java -public java.lang.String getAttrArn(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -##### \`attrRepositoryUri\`Required - -\`\`\`java -public java.lang.String getAttrRepositoryUri(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -##### \`tags\`Required - -\`\`\`java -public TagManager getTags(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) - -\`AWS::ECR::Repository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) - ---- - -##### \`encryptionConfiguration\`Required - -\`\`\`java -public java.lang.Object getEncryptionConfiguration(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.EncryptionConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) - ---- - -##### \`imageScanningConfiguration\`Required - -\`\`\`java -public java.lang.Object getImageScanningConfiguration(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.ImageScanningConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) - ---- - -##### \`repositoryPolicyText\`Required - -\`\`\`java -public java.lang.Object getRepositoryPolicyText(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) - ---- - -##### \`imageTagMutability\`Optional - -\`\`\`java -public java.lang.String getImageTagMutability(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.ImageTagMutability\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) - ---- - -##### \`lifecyclePolicy\`Optional - -\`\`\`java -public java.lang.Object getLifecyclePolicy(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) - -\`AWS::ECR::Repository.LifecyclePolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) - ---- - -##### \`repositoryName\`Optional - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesecrcfnrepositorypropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`java.lang.String\` - -The CloudFormation resource type name for this resource class. - ---- - -### Repository - -Define an ECR repository. - -#### Initializers - -\`\`\`java -import software.amazon.awscdk.services.ecr.Repository; - -Repository.Builder.create(Construct scope, java.lang.String id) -// .imageScanOnPush(java.lang.Boolean) -// .imageTagMutability(TagMutability) -// .lifecycleRegistryId(java.lang.String) -// .lifecycleRules(java.util.List) -// .removalPolicy(RemovalPolicy) -// .repositoryName(java.lang.String) - .build(); -\`\`\` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrrepositoryparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesecrrepositoryparameterid)* | \`java.lang.String\` | *No description.* | -| [\`imageScanOnPush\`](#softwareamazonawscdkservicesecrrepositorypropsparameterimagescanonpush) | \`java.lang.Boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrrepositorypropsparameterimagetagmutability) | [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#softwareamazonawscdkservicesecrrepositorypropsparameterlifecycleregistryid) | \`java.lang.String\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#softwareamazonawscdkservicesecrrepositorypropsparameterlifecyclerules) | java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#softwareamazonawscdkservicesecrrepositorypropsparameterremovalpolicy) | [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropsparameterrepositoryname) | \`java.lang.String\` | Name for this repository. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`imageScanOnPush\`Optional - -- *Type:* \`java.lang.Boolean\` -- *Default:* false - -Enable the scan on push when creating the repository. - ---- - -##### \`imageTagMutability\`Optional - -- *Type:* [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) -- *Default:* TagMutability.MUTABLE - -The tag mutability setting for the repository. - -If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. - ---- - -##### \`lifecycleRegistryId\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* The default registry is assumed. - -The AWS account ID associated with the registry that contains the repository. - -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html - ---- - -##### \`lifecycleRules\`Optional - -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> -- *Default:* No life cycle rules - -Life cycle rules to apply to this registry. - ---- - -##### \`removalPolicy\`Optional - -- *Type:* [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) -- *Default:* RemovalPolicy.Retain - -Determine what happens to the repository when the resource/stack is deleted. - ---- - -##### \`repositoryName\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* Automatically generated name. - -Name for this repository. - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`addLifecycleRule\`](#softwareamazonawscdkservicesecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | - ---- - -##### \`addLifecycleRule\` - -\`\`\`java -public addLifecycleRule(LifecycleRule rule) -\`\`\` - -###### \`rule\`Required - -- *Type:* [\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule) - ---- - -##### \`addToResourcePolicy\` - -\`\`\`java -public addToResourcePolicy(PolicyStatement statement) -\`\`\` - -###### \`statement\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) - ---- - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| [\`arnForLocalRepository\`](#softwareamazonawscdkservicesecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`fromRepositoryArn\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryarn) | *No description.* | -| [\`fromRepositoryAttributes\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`fromRepositoryName\`](#softwareamazonawscdkservicesecrrepositoryfromrepositoryname) | *No description.* | - ---- - -##### \`arnForLocalRepository\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.Repository; - -Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope) -Repository.arnForLocalRepository(java.lang.String repositoryName, IConstruct scope, java.lang.String account) -\`\`\` - -###### \`repositoryName\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`scope\`Required - -- *Type:* [\`software.constructs.IConstruct\`](#software.constructs.IConstruct) - ---- - -###### \`account\`Optional - -- *Type:* \`java.lang.String\` - ---- - -##### \`fromRepositoryArn\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.Repository; - -Repository.fromRepositoryArn(Construct scope, java.lang.String id, java.lang.String repositoryArn) -\`\`\` - -###### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`repositoryArn\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`fromRepositoryAttributes\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.Repository; - -Repository.fromRepositoryAttributes(Construct scope, java.lang.String id, RepositoryAttributes attrs) -\`\`\` - -###### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`attrs\`Required - -- *Type:* [\`software.amazon.awscdk.services.ecr.RepositoryAttributes\`](#software.amazon.awscdk.services.ecr.RepositoryAttributes) - ---- - -##### \`fromRepositoryName\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.Repository; - -Repository.fromRepositoryName(Construct scope, java.lang.String id, java.lang.String repositoryName) -\`\`\` - -###### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`repositoryName\`Required - -- *Type:* \`java.lang.String\` - ---- - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositorypropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | - ---- - -##### \`repositoryArn\`Required - -\`\`\`java -public java.lang.String getRepositoryArn(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The ARN of the repository. - ---- - -##### \`repositoryName\`Required - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The name of the repository. - ---- - - -### RepositoryBase - -- *Implements:* [\`software.amazon.awscdk.services.ecr.IRepository\`](#software.amazon.awscdk.services.ecr.IRepository) - -Base class for ECR repository. - -Reused between imported repositories and owned repositories. - -#### Initializers - -\`\`\`java -import software.amazon.awscdk.services.ecr.RepositoryBase; - -RepositoryBase.Builder.create(Construct scope, java.lang.String id) -// .account(java.lang.String) -// .environmentFromArn(java.lang.String) -// .physicalName(java.lang.String) -// .region(java.lang.String) - .build(); -\`\`\` - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrrepositorybaseparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesecrrepositorybaseparameterid)* | \`java.lang.String\` | *No description.* | -| [\`account\`](#softwareamazonawscdkcoreresourcepropsparameteraccount) | \`java.lang.String\` | The AWS account ID this resource belongs to. | -| [\`environmentFromArn\`](#softwareamazonawscdkcoreresourcepropsparameterenvironmentfromarn) | \`java.lang.String\` | ARN to deduce region and account from. | -| [\`physicalName\`](#softwareamazonawscdkcoreresourcepropsparameterphysicalname) | \`java.lang.String\` | The value passed in by users to the physical name prop of the resource. | -| [\`region\`](#softwareamazonawscdkcoreresourcepropsparameterregion) | \`java.lang.String\` | The AWS region this resource belongs to. | - ---- - -##### \`scope\`Required - -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) - ---- - -##### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`account\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* the resource is in the same account as the stack it belongs to - -The AWS account ID this resource belongs to. - ---- - -##### \`environmentFromArn\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. - -ARN to deduce region and account from. - -The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either \`account\` or \`region\`. - ---- - -##### \`physicalName\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* The physical name will be allocated by CloudFormation at deployment time - -The value passed in by users to the physical name prop of the resource. - -\`undefined\` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - \`PhysicalName.GENERATE_IF_NEEDED\` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. - ---- - -##### \`region\`Optional - -- *Type:* \`java.lang.String\` -- *Default:* the resource is in the same region as the stack it belongs to - -The AWS region this resource belongs to. - ---- - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#softwareamazonawscdkservicesecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#softwareamazonawscdkservicesecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grantPullPush\`](#softwareamazonawscdkservicesecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#softwareamazonawscdkservicesecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#softwareamazonawscdkservicesecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#softwareamazonawscdkservicesecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#softwareamazonawscdkservicesecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repositoryUriForDigest\`](#softwareamazonawscdkservicesecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#softwareamazonawscdkservicesecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | - ---- - -##### \`addToResourcePolicy\` - -\`\`\`java -public addToResourcePolicy(PolicyStatement statement) -\`\`\` - -###### \`statement\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) - ---- - -##### \`grant\` - -\`\`\`java -public grant(IGrantable grantee, java.lang.String actions) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -###### \`actions\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`grantPull\` - -\`\`\`java -public grantPull(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -##### \`grantPullPush\` - -\`\`\`java -public grantPullPush(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -##### \`onCloudTrailEvent\` - -\`\`\`java -public onCloudTrailEvent(java.lang.String id) -public onCloudTrailEvent(java.lang.String id, OnEventOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) - -Options for adding the rule. - ---- - -##### \`onCloudTrailImagePushed\` - -\`\`\`java -public onCloudTrailImagePushed(java.lang.String id) -public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions\`](#software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions) - -Options for adding the rule. - ---- - -##### \`onEvent\` - -\`\`\`java -public onEvent(java.lang.String id) -public onEvent(java.lang.String id, OnEventOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) - ---- - -##### \`onImageScanCompleted\` - -\`\`\`java -public onImageScanCompleted(java.lang.String id) -public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions\`](#software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions) - -Options for adding the rule. - ---- - -##### \`repositoryUriForDigest\` - -\`\`\`java -public repositoryUriForDigest() -public repositoryUriForDigest(java.lang.String digest) -\`\`\` - -###### \`digest\`Optional - -- *Type:* \`java.lang.String\` - -Optional image digest. - ---- - -##### \`repositoryUriForTag\` - -\`\`\`java -public repositoryUriForTag() -public repositoryUriForTag(java.lang.String tag) -\`\`\` - -###### \`tag\`Optional - -- *Type:* \`java.lang.String\` - -Optional image tag. - ---- - - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | -| [\`repositoryUri\`](#softwareamazonawscdkservicesecrrepositorybasepropertyrepositoryuri)* | \`java.lang.String\` | The URI of this repository (represents the latest image):. | - ---- - -##### \`repositoryArn\`Required - -\`\`\`java -public java.lang.String getRepositoryArn(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The ARN of the repository. - ---- - -##### \`repositoryName\`Required - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The name of the repository. - ---- - -##### \`repositoryUri\`Required - -\`\`\`java -public java.lang.String getRepositoryUri(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The URI of this repository (represents the latest image):. - -ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY - ---- - - -## Structs - -### CfnPublicRepositoryProps - -Properties for defining a \`AWS::ECR::PublicRepository\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps; - -CfnPublicRepositoryProps.builder() -// .repositoryCatalogData(java.lang.Object) -// .repositoryName(java.lang.String) -// .repositoryPolicyText(java.lang.Object) -// .tags(java.util.List) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | - ---- - -##### \`repositoryCatalogData\`Optional - -\`\`\`java -public java.lang.Object getRepositoryCatalogData(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) - ---- - -##### \`repositoryName\`Optional - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::PublicRepository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) - ---- - -##### \`repositoryPolicyText\`Optional - -\`\`\`java -public java.lang.Object getRepositoryPolicyText(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) - ---- - -##### \`tags\`Optional - -\`\`\`java -public java.util.List getTags(); -\`\`\` - -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> - -\`AWS::ECR::PublicRepository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) - ---- - -### CfnRegistryPolicyProps - -Properties for defining a \`AWS::ECR::RegistryPolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnRegistryPolicyProps; - -CfnRegistryPolicyProps.builder() - .policyText(java.lang.Object) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`policyText\`](#softwareamazonawscdkservicesecrcfnregistrypolicypropspropertypolicytext)* | \`java.lang.Object\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`policyText\`Required - -\`\`\`java -public java.lang.Object getPolicyText(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::RegistryPolicy.PolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) - ---- - -### CfnReplicationConfigurationProps - -Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnReplicationConfigurationProps; - -CfnReplicationConfigurationProps.builder() - .replicationConfiguration(IResolvable) - .replicationConfiguration(ReplicationConfigurationProperty) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`replicationConfiguration\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | - ---- - -##### \`replicationConfiguration\`Required - -\`\`\`java -public java.lang.Object getReplicationConfiguration(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) - -\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) - ---- - -### CfnRepositoryProps - -Properties for defining a \`AWS::ECR::Repository\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnRepositoryProps; - -CfnRepositoryProps.builder() -// .encryptionConfiguration(java.lang.Object) -// .imageScanningConfiguration(java.lang.Object) -// .imageTagMutability(java.lang.String) -// .lifecyclePolicy(IResolvable) -// .lifecyclePolicy(LifecyclePolicyProperty) -// .repositoryName(java.lang.String) -// .repositoryPolicyText(java.lang.Object) -// .tags(java.util.List) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`encryptionConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyencryptionconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyimagescanningconfiguration) | \`java.lang.Object\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyimagetagmutability) | \`java.lang.String\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertylifecyclepolicy) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertyrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnrepositorypropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::Repository.Tags\`. | - ---- - -##### \`encryptionConfiguration\`Optional - -\`\`\`java -public java.lang.Object getEncryptionConfiguration(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.EncryptionConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) - ---- - -##### \`imageScanningConfiguration\`Optional - -\`\`\`java -public java.lang.Object getImageScanningConfiguration(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.ImageScanningConfiguration\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) - ---- - -##### \`imageTagMutability\`Optional - -\`\`\`java -public java.lang.String getImageTagMutability(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.ImageTagMutability\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) - ---- - -##### \`lifecyclePolicy\`Optional - -\`\`\`java -public java.lang.Object getLifecyclePolicy(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty\`](#software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty) - -\`AWS::ECR::Repository.LifecyclePolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) - ---- - -##### \`repositoryName\`Optional - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`AWS::ECR::Repository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) - ---- - -##### \`repositoryPolicyText\`Optional - -\`\`\`java -public java.lang.Object getRepositoryPolicyText(); -\`\`\` - -- *Type:* \`java.lang.Object\` - -\`AWS::ECR::Repository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) - ---- - -##### \`tags\`Optional - -\`\`\`java -public java.util.List getTags(); -\`\`\` - -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> - -\`AWS::ECR::Repository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) - ---- - -### LifecyclePolicyProperty - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnRepository.LifecyclePolicyProperty; - -LifecyclePolicyProperty.builder() -// .lifecyclePolicyText(java.lang.String) -// .registryId(java.lang.String) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`lifecyclePolicyText\`](#softwareamazonawscdkservicesecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`java.lang.String\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registryId\`](#softwareamazonawscdkservicesecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`java.lang.String\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | - ---- - -##### \`lifecyclePolicyText\`Optional - -\`\`\`java -public java.lang.String getLifecyclePolicyText(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext) - ---- - -##### \`registryId\`Optional - -\`\`\`java -public java.lang.String getRegistryId(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`CfnRepository.LifecyclePolicyProperty.RegistryId\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid) - ---- - -### LifecycleRule - -An ECR life cycle rule. - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.LifecycleRule; - -LifecycleRule.builder() -// .description(java.lang.String) -// .maxImageAge(Duration) -// .maxImageCount(java.lang.Number) -// .rulePriority(java.lang.Number) -// .tagPrefixList(java.util.List) -// .tagStatus(TagStatus) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecrlifecyclerulepropertydescription) | \`java.lang.String\` | Describes the purpose of the rule. | -| [\`maxImageAge\`](#softwareamazonawscdkservicesecrlifecyclerulepropertymaximageage) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`maxImageCount\`](#softwareamazonawscdkservicesecrlifecyclerulepropertymaximagecount) | \`java.lang.Number\` | The maximum number of images to retain. | -| [\`rulePriority\`](#softwareamazonawscdkservicesecrlifecyclerulepropertyrulepriority) | \`java.lang.Number\` | Controls the order in which rules are evaluated (low to high). | -| [\`tagPrefixList\`](#softwareamazonawscdkservicesecrlifecyclerulepropertytagprefixlist) | java.util.List<\`java.lang.String\`> | Select images that have ALL the given prefixes in their tag. | -| [\`tagStatus\`](#softwareamazonawscdkservicesecrlifecyclerulepropertytagstatus) | [\`software.amazon.awscdk.services.ecr.TagStatus\`](#software.amazon.awscdk.services.ecr.TagStatus) | Select images based on tags. | - ---- - -##### \`description\`Optional - -\`\`\`java -public java.lang.String getDescription(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* No description - -Describes the purpose of the rule. - ---- - -##### \`maxImageAge\`Optional - -\`\`\`java -public Duration getMaxImageAge(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) - -The maximum age of images to retain. The value must represent a number of days. - -Specify exactly one of maxImageCount and maxImageAge. - ---- - -##### \`maxImageCount\`Optional - -\`\`\`java -public java.lang.Number getMaxImageCount(); -\`\`\` - -- *Type:* \`java.lang.Number\` - -The maximum number of images to retain. - -Specify exactly one of maxImageCount and maxImageAge. - ---- - -##### \`rulePriority\`Optional - -\`\`\`java -public java.lang.Number getRulePriority(); -\`\`\` - -- *Type:* \`java.lang.Number\` -- *Default:* Automatically assigned - -Controls the order in which rules are evaluated (low to high). - -All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. - ---- - -##### \`tagPrefixList\`Optional - -\`\`\`java -public java.util.List getTagPrefixList(); -\`\`\` - -- *Type:* java.util.List<\`java.lang.String\`> - -Select images that have ALL the given prefixes in their tag. - -Only if tagStatus == TagStatus.Tagged - ---- - -##### \`tagStatus\`Optional - -\`\`\`java -public TagStatus getTagStatus(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.ecr.TagStatus\`](#software.amazon.awscdk.services.ecr.TagStatus) -- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise - -Select images based on tags. - -Only one rule is allowed to select untagged images, and it must have the highest rulePriority. - ---- - -### OnCloudTrailImagePushedOptions - -Options for the onCloudTrailImagePushed method. - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions; - -OnCloudTrailImagePushedOptions.builder() -// .description(java.lang.String) -// .eventPattern(EventPattern) -// .ruleName(java.lang.String) -// .target(IRuleTarget) -// .imageTag(java.lang.String) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertydescription) | \`java.lang.String\` | A description of the rule's purpose. | -| [\`eventPattern\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyrulename) | \`java.lang.String\` | A name for the rule. | -| [\`target\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertytarget) | [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) | The target to register for the event. | -| [\`imageTag\`](#softwareamazonawscdkservicesecroncloudtrailimagepushedoptionspropertyimagetag) | \`java.lang.String\` | Only watch changes to this image tag. | - ---- - -##### \`description\`Optional - -\`\`\`java -public java.lang.String getDescription(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -##### \`eventPattern\`Optional - -\`\`\`java -public EventPattern getEventPattern(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -##### \`ruleName\`Optional - -\`\`\`java -public java.lang.String getRuleName(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -##### \`target\`Optional - -\`\`\`java -public IRuleTarget getTarget(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -##### \`imageTag\`Optional - -\`\`\`java -public java.lang.String getImageTag(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* Watch changes to all tags - -Only watch changes to this image tag. - ---- - -### OnImageScanCompletedOptions - -Options for the OnImageScanCompleted method. - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions; - -OnImageScanCompletedOptions.builder() -// .description(java.lang.String) -// .eventPattern(EventPattern) -// .ruleName(java.lang.String) -// .target(IRuleTarget) -// .imageTags(java.util.List) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`description\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertydescription) | \`java.lang.String\` | A description of the rule's purpose. | -| [\`eventPattern\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyeventpattern) | [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyrulename) | \`java.lang.String\` | A name for the rule. | -| [\`target\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertytarget) | [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) | The target to register for the event. | -| [\`imageTags\`](#softwareamazonawscdkservicesecronimagescancompletedoptionspropertyimagetags) | java.util.List<\`java.lang.String\`> | Only watch changes to the image tags spedified. | - ---- - -##### \`description\`Optional - -\`\`\`java -public java.lang.String getDescription(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* No description - -A description of the rule's purpose. - ---- - -##### \`eventPattern\`Optional - -\`\`\`java -public EventPattern getEventPattern(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.events.EventPattern\`](#software.amazon.awscdk.services.events.EventPattern) -- *Default:* No additional filtering based on an event pattern. - -Additional restrictions for the event to route to the specified target. - -The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. - -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html - ---- - -##### \`ruleName\`Optional - -\`\`\`java -public java.lang.String getRuleName(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* AWS CloudFormation generates a unique physical ID. - -A name for the rule. - ---- - -##### \`target\`Optional - -\`\`\`java -public IRuleTarget getTarget(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.events.IRuleTarget\`](#software.amazon.awscdk.services.events.IRuleTarget) -- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. - -The target to register for the event. - ---- - -##### \`imageTags\`Optional - -\`\`\`java -public java.util.List getImageTags(); -\`\`\` - -- *Type:* java.util.List<\`java.lang.String\`> -- *Default:* Watch the changes to the repository with all image tags - -Only watch changes to the image tags spedified. - -Leave it undefined to watch the full repository. - ---- - -### ReplicationConfigurationProperty - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty; - -ReplicationConfigurationProperty.builder() - .rules(IResolvable) - .rules(java.util.List) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`rules\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty)> | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | - ---- - -##### \`rules\`Required - -\`\`\`java -public java.lang.Object getRules(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty)> - -\`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules) - ---- - -### ReplicationDestinationProperty - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty; - -ReplicationDestinationProperty.builder() - .region(java.lang.String) - .registryId(java.lang.String) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`region\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`java.lang.String\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registryId\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`java.lang.String\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | - ---- - -##### \`region\`Required - -\`\`\`java -public java.lang.String getRegion(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region) - ---- - -##### \`registryId\`Required - -\`\`\`java -public java.lang.String getRegistryId(); -\`\`\` - -- *Type:* \`java.lang.String\` - -\`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid) - ---- - -### ReplicationRuleProperty - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationRuleProperty; - -ReplicationRuleProperty.builder() - .destinations(IResolvable) - .destinations(java.util.List) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`destinations\`](#softwareamazonawscdkservicesecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)> | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | - ---- - -##### \`destinations\`Required - -\`\`\`java -public java.lang.Object getDestinations(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR [\`software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#software.amazon.awscdk.services.ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)> - -\`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations) - ---- - -### RepositoryAttributes - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.RepositoryAttributes; - -RepositoryAttributes.builder() - .repositoryArn(java.lang.String) - .repositoryName(java.lang.String) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrrepositoryattributespropertyrepositoryarn)* | \`java.lang.String\` | *No description.* | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositoryattributespropertyrepositoryname)* | \`java.lang.String\` | *No description.* | - ---- - -##### \`repositoryArn\`Required - -\`\`\`java -public java.lang.String getRepositoryArn(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -##### \`repositoryName\`Required - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - ---- - -### RepositoryProps - -#### Initializer - -\`\`\`java -import software.amazon.awscdk.services.ecr.RepositoryProps; - -RepositoryProps.builder() -// .imageScanOnPush(java.lang.Boolean) -// .imageTagMutability(TagMutability) -// .lifecycleRegistryId(java.lang.String) -// .lifecycleRules(java.util.List) -// .removalPolicy(RemovalPolicy) -// .repositoryName(java.lang.String) - .build(); -\`\`\` - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`imageScanOnPush\`](#softwareamazonawscdkservicesecrrepositorypropspropertyimagescanonpush) | \`java.lang.Boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#softwareamazonawscdkservicesecrrepositorypropspropertyimagetagmutability) | [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#softwareamazonawscdkservicesecrrepositorypropspropertylifecycleregistryid) | \`java.lang.String\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#softwareamazonawscdkservicesecrrepositorypropspropertylifecyclerules) | java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#softwareamazonawscdkservicesecrrepositorypropspropertyremovalpolicy) | [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrrepositorypropspropertyrepositoryname) | \`java.lang.String\` | Name for this repository. | - ---- - -##### \`imageScanOnPush\`Optional - -\`\`\`java -public java.lang.Boolean getImageScanOnPush(); -\`\`\` - -- *Type:* \`java.lang.Boolean\` -- *Default:* false - -Enable the scan on push when creating the repository. - ---- - -##### \`imageTagMutability\`Optional - -\`\`\`java -public TagMutability getImageTagMutability(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.services.ecr.TagMutability\`](#software.amazon.awscdk.services.ecr.TagMutability) -- *Default:* TagMutability.MUTABLE - -The tag mutability setting for the repository. - -If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. - ---- - -##### \`lifecycleRegistryId\`Optional - -\`\`\`java -public java.lang.String getLifecycleRegistryId(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* The default registry is assumed. - -The AWS account ID associated with the registry that contains the repository. - -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html - ---- - -##### \`lifecycleRules\`Optional - -\`\`\`java -public java.util.List getLifecycleRules(); -\`\`\` - -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ecr.LifecycleRule\`](#software.amazon.awscdk.services.ecr.LifecycleRule)> -- *Default:* No life cycle rules - -Life cycle rules to apply to this registry. - ---- - -##### \`removalPolicy\`Optional - -\`\`\`java -public RemovalPolicy getRemovalPolicy(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.RemovalPolicy\`](#software.amazon.awscdk.core.RemovalPolicy) -- *Default:* RemovalPolicy.Retain - -Determine what happens to the repository when the resource/stack is deleted. - ---- - -##### \`repositoryName\`Optional - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` -- *Default:* Automatically generated name. - -Name for this repository. - ---- - -## Classes - -### AuthorizationToken - -Authorization token to access private ECR repositories in the current environment via Docker CLI. - -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html - - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| [\`grantRead\`](#softwareamazonawscdkservicesecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | - ---- - -##### \`grantRead\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.AuthorizationToken; - -AuthorizationToken.grantRead(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - - - -### PublicGalleryAuthorizationToken - -Authorization token to access the global public ECR Gallery via Docker CLI. - -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth - - -#### Static Functions - -| **Name** | **Description** | -| --- | --- | -| [\`grantRead\`](#softwareamazonawscdkservicesecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | - ---- - -##### \`grantRead\` - -\`\`\`java -import software.amazon.awscdk.services.ecr.PublicGalleryAuthorizationToken; - -PublicGalleryAuthorizationToken.grantRead(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - - - -## Protocols - -### IRepository - -- *Extends:* [\`software.amazon.awscdk.core.IResource\`](#software.amazon.awscdk.core.IResource) - -- *Implemented By:* [\`software.amazon.awscdk.services.ecr.Repository\`](#software.amazon.awscdk.services.ecr.Repository), [\`software.amazon.awscdk.services.ecr.RepositoryBase\`](#software.amazon.awscdk.services.ecr.RepositoryBase), [\`software.amazon.awscdk.services.ecr.IRepository\`](#software.amazon.awscdk.services.ecr.IRepository) - -Represents an ECR repository. - -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#softwareamazonawscdkservicesecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#softwareamazonawscdkservicesecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#softwareamazonawscdkservicesecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#softwareamazonawscdkservicesecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#softwareamazonawscdkservicesecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | - ---- - -##### \`addToResourcePolicy\` - -\`\`\`java -public addToResourcePolicy(PolicyStatement statement) -\`\`\` - -###### \`statement\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) - ---- - -##### \`grant\` - -\`\`\`java -public grant(IGrantable grantee, java.lang.String actions) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -###### \`actions\`Required - -- *Type:* \`java.lang.String\` - ---- - -##### \`grantPull\` - -\`\`\`java -public grantPull(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -##### \`grantPullPush\` - -\`\`\`java -public grantPullPush(IGrantable grantee) -\`\`\` - -###### \`grantee\`Required - -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) - ---- - -##### \`onCloudTrailEvent\` - -\`\`\`java -public onCloudTrailEvent(java.lang.String id) -public onCloudTrailEvent(java.lang.String id, OnEventOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) - -Options for adding the rule. - ---- - -##### \`onCloudTrailImagePushed\` - -\`\`\`java -public onCloudTrailImagePushed(java.lang.String id) -public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions\`](#software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions) - -Options for adding the rule. - ---- - -##### \`onEvent\` - -\`\`\`java -public onEvent(java.lang.String id) -public onEvent(java.lang.String id, OnEventOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) - ---- - -##### \`onImageScanCompleted\` - -\`\`\`java -public onImageScanCompleted(java.lang.String id) -public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) -\`\`\` - -###### \`id\`Required - -- *Type:* \`java.lang.String\` - -The id of the rule. - ---- - -###### \`options\`Optional - -- *Type:* [\`software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions\`](#software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions) - -Options for adding the rule. - ---- - -##### \`repositoryUriForDigest\` - -\`\`\`java -public repositoryUriForDigest() -public repositoryUriForDigest(java.lang.String digest) -\`\`\` - -###### \`digest\`Optional - -- *Type:* \`java.lang.String\` - -Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). - ---- - -##### \`repositoryUriForTag\` - -\`\`\`java -public repositoryUriForTag() -public repositoryUriForTag(java.lang.String tag) -\`\`\` - -###### \`tag\`Optional - -- *Type:* \`java.lang.String\` - -Image tag to use (tools usually default to \\"latest\\" if omitted). - ---- - -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`node\`](#softwareamazonawscdkservicesecrirepositorypropertynode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#softwareamazonawscdkservicesecrirepositorypropertyenv)* | [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkservicesecrirepositorypropertystack)* | [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | -| [\`repositoryUri\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryuri)* | \`java.lang.String\` | The URI of this repository (represents the latest image):. | - ---- - -##### \`node\`Required - -\`\`\`java -public ConstructNode getNode(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) - -The construct tree node for this construct. - ---- - -##### \`env\`Required - -\`\`\`java -public ResourceEnvironment getEnv(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) - -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. - ---- - -##### \`stack\`Required - -\`\`\`java -public Stack getStack(); -\`\`\` - -- *Type:* [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) - -The stack in which this resource is defined. - ---- - -##### \`repositoryArn\`Required - -\`\`\`java -public java.lang.String getRepositoryArn(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The ARN of the repository. - ---- - -##### \`repositoryName\`Required - -\`\`\`java -public java.lang.String getRepositoryName(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The name of the repository. - ---- - -##### \`repositoryUri\`Required - -\`\`\`java -public java.lang.String getRepositoryUri(); -\`\`\` - -- *Type:* \`java.lang.String\` - -The URI of this repository (represents the latest image):. - -ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY - ---- - -## Enums - -### TagMutability - -| **Name** | **Description** | -| --- | --- | -| [\`MUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | - ---- - -The tag mutability setting for your repository. - -#### \`MUTABLE\` - -allow image tags to be overwritten. - ---- - - -#### \`IMMUTABLE\` - -all image tags within the repository will be immutable which will prevent them from being overwritten. - ---- - - -### TagStatus - -| **Name** | **Description** | -| --- | --- | -| [\`ANY\`](#softwareamazonawscdkservicesecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#softwareamazonawscdkservicesecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#softwareamazonawscdkservicesecrtagstatusuntagged) | Rule applies to untagged images. | - ---- - -Select images based on tags. - -#### \`ANY\` - -Rule applies to all images. - ---- - - -#### \`TAGGED\` - -Rule applies to tagged images. - ---- - - -#### \`UNTAGGED\` - -Rule applies to untagged images. - ---- - -" -`; - -exports[`java snapshot - submodules 1`] = ` -"# Amazon EKS Construct Library - - ---- - -![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) - -![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge) - ---- - - - -This construct library allows you to define [Amazon Elastic Container Service for Kubernetes (EKS)](https://aws.amazon.com/eks/) clusters. -In addition, the library also supports defining Kubernetes resource manifests within EKS clusters. - -## Table Of Contents - -* [Quick Start](#quick-start) -* [API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-eks-readme.html) -* [Architectural Overview](#architectural-overview) -* [Provisioning clusters](#provisioning-clusters) - * [Managed node groups](#managed-node-groups) - * [Fargate Profiles](#fargate-profiles) - * [Self-managed nodes](#self-managed-nodes) - * [Endpoint Access](#endpoint-access) - * [VPC Support](#vpc-support) - * [Kubectl Support](#kubectl-support) - * [ARM64 Support](#arm64-support) - * [Masters Role](#masters-role) - * [Encryption](#encryption) -* [Permissions and Security](#permissions-and-security) -* [Applying Kubernetes Resources](#applying-kubernetes-resources) - * [Kubernetes Manifests](#kubernetes-manifests) - * [Helm Charts](#helm-charts) - * [CDK8s Charts](#cdk8s-charts) -* [Patching Kubernetes Resources](#patching-kubernetes-resources) -* [Querying Kubernetes Resources](#querying-kubernetes-resources) -* [Using existing clusters](#using-existing-clusters) -* [Known Issues and Limitations](#known-issues-and-limitations) - -## Quick Start - -This example defines an Amazon EKS cluster with the following configuration: - -* Dedicated VPC with default configuration (Implicitly created using [ec2.Vpc](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ec2-readme.html#vpc)) -* A Kubernetes pod with a container based on the [paulbouwer/hello-kubernetes](https://github.com/paulbouwer/hello-kubernetes) image. - -\`\`\`ts -// provisiong a cluster -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_19, -}); - -// apply a kubernetes manifest to the cluster -cluster.addManifest('mypod', { - apiVersion: 'v1', - kind: 'Pod', - metadata: { name: 'mypod' }, - spec: { - containers: [ - { - name: 'hello', - image: 'paulbouwer/hello-kubernetes:1.5', - ports: [ { containerPort: 8080 } ] - } - ] - } -}); -\`\`\` - -In order to interact with your cluster through \`kubectl\`, you can use the \`aws eks update-kubeconfig\` [AWS CLI command](https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html) -to configure your local kubeconfig. The EKS module will define a CloudFormation output in your stack which contains the command to run. For example: - -\`\`\`plaintext -Outputs: -ClusterConfigCommand43AAE40F = aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -\`\`\` - -Execute the \`aws eks update-kubeconfig ...\` command in your terminal to create or update a local kubeconfig context: - -\`\`\`console -$ aws eks update-kubeconfig --name cluster-xxxxx --role-arn arn:aws:iam::112233445566:role/yyyyy -Added new context arn:aws:eks:rrrrr:112233445566:cluster/cluster-xxxxx to /home/boom/.kube/config -\`\`\` - -And now you can simply use \`kubectl\`: - -\`\`\`console -$ kubectl get all -n kube-system -NAME READY STATUS RESTARTS AGE -pod/aws-node-fpmwv 1/1 Running 0 21m -pod/aws-node-m9htf 1/1 Running 0 21m -pod/coredns-5cb4fb54c7-q222j 1/1 Running 0 23m -pod/coredns-5cb4fb54c7-v9nxx 1/1 Running 0 23m -... -\`\`\` - -## Architectural Overview - -The following is a qualitative diagram of the various possible components involved in the cluster deployment. - -\`\`\`text - +-----------------------------------------------+ +-----------------+ - | EKS Cluster | kubectl | | - |-----------------------------------------------|<-------------+| Kubectl Handler | - | | | | - | | +-----------------+ - | +--------------------+ +-----------------+ | - | | | | | | - | | Managed Node Group | | Fargate Profile | | +-----------------+ - | | | | | | | | - | +--------------------+ +-----------------+ | | Cluster Handler | - | | | | - +-----------------------------------------------+ +-----------------+ - ^ ^ + - | | | - | connect self managed capacity | | aws-sdk - | | create/update/delete | - + | v - +--------------------+ + +-------------------+ - | | --------------+| eks.amazonaws.com | - | Auto Scaling Group | +-------------------+ - | | - +--------------------+ -\`\`\` - -In a nutshell: - -* \`EKS Cluster\` - The cluster endpoint created by EKS. -* \`Managed Node Group\` - EC2 worker nodes managed by EKS. -* \`Fargate Profile\` - Fargate worker nodes managed by EKS. -* \`Auto Scaling Group\` - EC2 worker nodes managed by the user. -* \`KubectlHandler\` - Lambda function for invoking \`kubectl\` commands on the cluster - created by CDK. -* \`ClusterHandler\` - Lambda function for interacting with EKS API to manage the cluster lifecycle - created by CDK. - -A more detailed breakdown of each is provided further down this README. - -## Provisioning clusters - -Creating a new cluster is done using the \`Cluster\` or \`FargateCluster\` constructs. The only required property is the kubernetes \`version\`. - -\`\`\`ts -new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, -}); -\`\`\` - -You can also use \`FargateCluster\` to provision a cluster that uses only fargate workers. - -\`\`\`ts -new eks.FargateCluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, -}); -\`\`\` - -> **NOTE: Only 1 cluster per stack is supported.** If you have a use-case for multiple clusters per stack, or would like to understand more about this limitation, see . - -Below you'll find a few important cluster configuration options. First of which is Capacity. -Capacity is the amount and the type of worker nodes that are available to the cluster for deploying resources. Amazon EKS offers 3 ways of configuring capacity, which you can combine as you like: - -### Managed node groups - -Amazon EKS managed node groups automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. -With Amazon EKS managed node groups, you don’t need to separately provision or register the Amazon EC2 instances that provide compute capacity to run your Kubernetes applications. You can create, update, or terminate nodes for your cluster with a single operation. Nodes run using the latest Amazon EKS optimized AMIs in your AWS account while node updates and terminations gracefully drain nodes to ensure that your applications stay available. - -> For more details visit [Amazon EKS Managed Node Groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). - -**Managed Node Groups are the recommended way to allocate cluster capacity.** - -By default, this library will allocate a managed node group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). - -At cluster instantiation time, you can customize the number of instances and their type: - -\`\`\`ts -new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, - defaultCapacity: 5, - defaultCapacityInstance: ec2.InstanceType.of(ec2.InstanceClass.M5, ec2.InstanceSize.SMALL), -}); -\`\`\` - -To access the node group that was created on your behalf, you can use \`cluster.defaultNodegroup\`. - -Additional customizations are available post instantiation. To apply them, set the default capacity to 0, and use the \`cluster.addNodegroupCapacity\` method: - -\`\`\`ts -const cluster = new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, - defaultCapacity: 0, -}); - -cluster.addNodegroupCapacity('custom-node-group', { - instanceTypes: [new ec2.InstanceType('m5.large')], - minSize: 4, - diskSize: 100, - amiType: eks.NodegroupAmiType.AL2_X86_64_GPU, - ... -}); -\`\`\` - -#### Spot Instances Support - -Use \`capacityType\` to create managed node groups comprised of spot instances. To maximize the availability of your applications while using -Spot Instances, we recommend that you configure a Spot managed node group to use multiple instance types with the \`instanceTypes\` property. - -> For more details visit [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types). - - -\`\`\`ts -cluster.addNodegroupCapacity('extra-ng-spot', { - instanceTypes: [ - new ec2.InstanceType('c5.large'), - new ec2.InstanceType('c5a.large'), - new ec2.InstanceType('c5d.large'), - ], - minSize: 3, - capacityType: eks.CapacityType.SPOT, -}); - -\`\`\` - -#### Launch Template Support - -You can specify a launch template that the node group will use. For example, this can be useful if you want to use -a custom AMI or add custom user data. - -When supplying a custom user data script, it must be encoded in the MIME multi-part archive format, since Amazon EKS merges with its own user data. Visit the [Launch Template Docs](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) -for mode details. - -\`\`\`ts -const userData = \`MIME-Version: 1.0 -Content-Type: multipart/mixed; boundary=\\"==MYBOUNDARY==\\" - ---==MYBOUNDARY== -Content-Type: text/x-shellscript; charset=\\"us-ascii\\" - -#!/bin/bash -echo \\"Running custom user data script\\" - ---==MYBOUNDARY==--\\\\\\\\ -\`; -const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { - launchTemplateData: { - instanceType: 't3.small', - userData: Fn.base64(userData), - }, -}); -cluster.addNodegroupCapacity('extra-ng', { - launchTemplateSpec: { - id: lt.ref, - version: lt.attrLatestVersionNumber, - }, -}); - -\`\`\` - -Note that when using a custom AMI, Amazon EKS doesn't merge any user data. Which means you do not need the multi-part encoding. and are responsible for supplying the required bootstrap commands for nodes to join the cluster. -In the following example, \`/ect/eks/bootstrap.sh\` from the AMI will be used to bootstrap the node. - -\`\`\`ts -const userData = ec2.UserData.forLinux(); -userData.addCommands( - 'set -o xtrace', - \`/etc/eks/bootstrap.sh \${cluster.clusterName}\`, -); -const lt = new ec2.CfnLaunchTemplate(this, 'LaunchTemplate', { - launchTemplateData: { - imageId: 'some-ami-id', // custom AMI - instanceType: 't3.small', - userData: Fn.base64(userData.render()), - }, -}); -cluster.addNodegroupCapacity('extra-ng', { - launchTemplateSpec: { - id: lt.ref, - version: lt.attrLatestVersionNumber, - }, -}); -\`\`\` - -You may specify one \`instanceType\` in the launch template or multiple \`instanceTypes\` in the node group, **but not both**. - -> For more details visit [Launch Template Support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html). - -Graviton 2 instance types are supported including \`c6g\`, \`m6g\`, \`r6g\` and \`t4g\`. - -### Fargate profiles - -AWS Fargate is a technology that provides on-demand, right-sized compute -capacity for containers. With AWS Fargate, you no longer have to provision, -configure, or scale groups of virtual machines to run containers. This removes -the need to choose server types, decide when to scale your node groups, or -optimize cluster packing. - -You can control which pods start on Fargate and how they run with Fargate -Profiles, which are defined as part of your Amazon EKS cluster. - -See [Fargate Considerations](https://docs.aws.amazon.com/eks/latest/userguide/fargate.html#fargate-considerations) in the AWS EKS User Guide. - -You can add Fargate Profiles to any EKS cluster defined in your CDK app -through the \`addFargateProfile()\` method. The following example adds a profile -that will match all pods from the \\"default\\" namespace: - -\`\`\`ts -cluster.addFargateProfile('MyProfile', { - selectors: [ { namespace: 'default' } ] -}); -\`\`\` - -You can also directly use the \`FargateProfile\` construct to create profiles under different scopes: - -\`\`\`ts -new eks.FargateProfile(scope, 'MyProfile', { - cluster, - ... -}); -\`\`\` - -To create an EKS cluster that **only** uses Fargate capacity, you can use \`FargateCluster\`. -The following code defines an Amazon EKS cluster with a default Fargate Profile that matches all pods from the \\"kube-system\\" and \\"default\\" namespaces. It is also configured to [run CoreDNS on Fargate](https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns). - -\`\`\`ts -const cluster = new eks.FargateCluster(this, 'MyCluster', { - version: eks.KubernetesVersion.V1_19, -}); -\`\`\` - -**NOTE**: Classic Load Balancers and Network Load Balancers are not supported on -pods running on Fargate. For ingress, we recommend that you use the [ALB Ingress -Controller](https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html) -on Amazon EKS (minimum version v1.1.4). - -### Self-managed nodes - -Another way of allocating capacity to an EKS cluster is by using self-managed nodes. -EC2 instances that are part of the auto-scaling group will serve as worker nodes for the cluster. -This type of capacity is also commonly referred to as *EC2 Capacity** or *EC2 Nodes*. - -For a detailed overview please visit [Self Managed Nodes](https://docs.aws.amazon.com/eks/latest/userguide/worker.html). - -Creating an auto-scaling group and connecting it to the cluster is done using the \`cluster.addAutoScalingGroupCapacity\` method: - -\`\`\`ts -cluster.addAutoScalingGroupCapacity('frontend-nodes', { - instanceType: new ec2.InstanceType('t2.medium'), - minCapacity: 3, - vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC } -}); -\`\`\` - -To connect an already initialized auto-scaling group, use the \`cluster.connectAutoScalingGroupCapacity()\` method: - -\`\`\`ts -const asg = new ec2.AutoScalingGroup(...); -cluster.connectAutoScalingGroupCapacity(asg); -\`\`\` - -In both cases, the [cluster security group](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html#cluster-sg) will be automatically attached to -the auto-scaling group, allowing for traffic to flow freely between managed and self-managed nodes. - -> **Note:** The default \`updateType\` for auto-scaling groups does not replace existing nodes. Since security groups are determined at launch time, self-managed nodes that were provisioned with version \`1.78.0\` or lower, will not be updated. -> To apply the new configuration on all your self-managed nodes, you'll need to replace the nodes using the \`UpdateType.REPLACING_UPDATE\` policy for the [\`updateType\`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-autoscaling.AutoScalingGroup.html#updatetypespan-classapi-icon-api-icon-deprecated-titlethis-api-element-is-deprecated-its-use-is-not-recommended%EF%B8%8Fspan) property. - -You can customize the [/etc/eks/boostrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) script, which is responsible -for bootstrapping the node to the EKS cluster. For example, you can use \`kubeletExtraArgs\` to add custom node labels or taints. - -\`\`\`ts -cluster.addAutoScalingGroupCapacity('spot', { - instanceType: new ec2.InstanceType('t3.large'), - minCapacity: 2, - bootstrapOptions: { - kubeletExtraArgs: '--node-labels foo=bar,goo=far', - awsApiRetryAttempts: 5 - } -}); -\`\`\` - -To disable bootstrapping altogether (i.e. to fully customize user-data), set \`bootstrapEnabled\` to \`false\`. -You can also configure the cluster to use an auto-scaling group as the default capacity: - -\`\`\`ts -cluster = new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, - defaultCapacityType: eks.DefaultCapacityType.EC2, -}); -\`\`\` - -This will allocate an auto-scaling group with 2 *m5.large* instances (this instance type suits most common use-cases, and is good value for money). -To access the \`AutoScalingGroup\` that was created on your behalf, you can use \`cluster.defaultCapacity\`. -You can also independently create an \`AutoScalingGroup\` and connect it to the cluster using the \`cluster.connectAutoScalingGroupCapacity\` method: - -\`\`\`ts -const asg = new ec2.AutoScalingGroup(...) -cluster.connectAutoScalingGroupCapacity(asg); -\`\`\` - -This will add the necessary user-data to access the apiserver and configure all connections, roles, and tags needed for the instances in the auto-scaling group to properly join the cluster. - -#### Spot Instances - -When using self-managed nodes, you can configure the capacity to use spot instances, greatly reducing capacity cost. -To enable spot capacity, use the \`spotPrice\` property: - -\`\`\`ts -cluster.addAutoScalingGroupCapacity('spot', { - spotPrice: '0.1094', - instanceType: new ec2.InstanceType('t3.large'), - maxCapacity: 10 -}); -\`\`\` - -> Spot instance nodes will be labeled with \`lifecycle=Ec2Spot\` and tainted with \`PreferNoSchedule\`. - -The [AWS Node Termination Handler](https://github.com/aws/aws-node-termination-handler) \`DaemonSet\` will be -installed from [Amazon EKS Helm chart repository](https://github.com/aws/eks-charts/tree/master/stable/aws-node-termination-handler) on these nodes. -The termination handler ensures that the Kubernetes control plane responds appropriately to events that -can cause your EC2 instance to become unavailable, such as [EC2 maintenance events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) -and [EC2 Spot interruptions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) and helps gracefully stop all pods running on spot nodes that are about to be -terminated. - -> Handler Version: [1.7.0](https://github.com/aws/aws-node-termination-handler/releases/tag/v1.7.0) -> -> Chart Version: [0.9.5](https://github.com/aws/eks-charts/blob/v0.0.28/stable/aws-node-termination-handler/Chart.yaml) - -To disable the installation of the termination handler, set the \`spotInterruptHandler\` property to \`false\`. This applies both to \`addAutoScalingGroupCapacity\` and \`connectAutoScalingGroupCapacity\`. - -#### Bottlerocket - -[Bottlerocket](https://aws.amazon.com/bottlerocket/) is a Linux-based open-source operating system that is purpose-built by Amazon Web Services for running containers on virtual machines or bare metal hosts. -At this moment, \`Bottlerocket\` is only supported when using self-managed auto-scaling groups. - -> **NOTICE**: Bottlerocket is only available in [some supported AWS regions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/QUICKSTART-EKS.md#finding-an-ami). - -The following example will create an auto-scaling group of 2 \`t3.small\` Linux instances running with the \`Bottlerocket\` AMI. - -\`\`\`ts -cluster.addAutoScalingGroupCapacity('BottlerocketNodes', { - instanceType: new ec2.InstanceType('t3.small'), - minCapacity: 2, - machineImageType: eks.MachineImageType.BOTTLEROCKET -}); -\`\`\` - -The specific Bottlerocket AMI variant will be auto selected according to the k8s version for the \`x86_64\` architecture. -For example, if the Amazon EKS cluster version is \`1.17\`, the Bottlerocket AMI variant will be auto selected as -\`aws-k8s-1.17\` behind the scene. - -> See [Variants](https://github.com/bottlerocket-os/bottlerocket/blob/develop/README.md#variants) for more details. - -Please note Bottlerocket does not allow to customize bootstrap options and \`bootstrapOptions\` properties is not supported when you create the \`Bottlerocket\` capacity. - -### Endpoint Access - -When you create a new cluster, Amazon EKS creates an endpoint for the managed Kubernetes API server that you use to communicate with your cluster (using Kubernetes management tools such as \`kubectl\`) - -By default, this API server endpoint is public to the internet, and access to the API server is secured using a combination of -AWS Identity and Access Management (IAM) and native Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC). - -You can configure the [cluster endpoint access](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) by using the \`endpointAccess\` property: - -\`\`\`ts -const cluster = new eks.Cluster(this, 'hello-eks', { - version: eks.KubernetesVersion.V1_19, - endpointAccess: eks.EndpointAccess.PRIVATE // No access outside of your VPC. -}); -\`\`\` - -The default value is \`eks.EndpointAccess.PUBLIC_AND_PRIVATE\`. Which means the cluster endpoint is accessible from outside of your VPC, but worker node traffic and \`kubectl\` commands issued by this library stay within your VPC. - -### VPC Support - -You can specify the VPC of the cluster using the \`vpc\` and \`vpcSubnets\` properties: - -\`\`\`ts -const vpc = new ec2.Vpc(this, 'Vpc'); - -new eks.Cluster(this, 'HelloEKS', { - version: eks.KubernetesVersion.V1_19, - vpc, - vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE }] -}); -\`\`\` - -> Note: Isolated VPCs (i.e with no internet access) are not currently supported. See https://github.com/aws/aws-cdk/issues/12171 - -If you do not specify a VPC, one will be created on your behalf, which you can then access via \`cluster.vpc\`. The cluster VPC will be associated to any EKS managed capacity (i.e Managed Node Groups and Fargate Profiles). +If you do not specify a VPC, one will be created on your behalf, which you can then access via \`cluster.vpc\`. The cluster VPC will be associated to any EKS managed capacity (i.e Managed Node Groups and Fargate Profiles). If you allocate self managed capacity, you can specify which subnets should the auto-scaling group use: @@ -35386,15 +32277,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.AwsAuth; @@ -35406,27 +32297,27 @@ AwsAuth.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksawsauthparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksawsauthparameterid)* | \`java.lang.String\` | *No description.* | -| [\`cluster\`](#softwareamazonawscdkserviceseksawsauthpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply this configuration to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply this configuration to. @@ -35434,93 +32325,93 @@ The EKS cluster to apply this configuration to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAccount\`](#softwareamazonawscdkserviceseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`addMastersRole\`](#softwareamazonawscdkserviceseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`addRoleMapping\`](#softwareamazonawscdkserviceseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`addUserMapping\`](#softwareamazonawscdkserviceseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| addAccount | Additional AWS account to add to the aws-auth configmap. | +| addMastersRole | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| addRoleMapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| addUserMapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`addAccount\` +##### \`addAccount\` \`\`\`java public addAccount(java.lang.String accountId) \`\`\` -###### \`accountId\`Required +###### \`accountId\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String account number. --- -##### \`addMastersRole\` +##### \`addMastersRole\` \`\`\`java public addMastersRole(IRole role) public addMastersRole(IRole role, java.lang.String username) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The IAM role to add. --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Optional user (defaults to the role ARN). --- -##### \`addRoleMapping\` +##### \`addRoleMapping\` \`\`\`java public addRoleMapping(IRole role, AwsAuthMapping mapping) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The IAM role to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuthMapping\`](#software.amazon.awscdk.services.eks.AwsAuthMapping) +- *Type:* software.amazon.awscdk.services.eks.AwsAuthMapping Mapping to k8s user name and groups. --- -##### \`addUserMapping\` +##### \`addUserMapping\` \`\`\`java public addUserMapping(IUser user, AwsAuthMapping mapping) \`\`\` -###### \`user\`Required +###### \`user\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IUser\`](#software.amazon.awscdk.services.iam.IUser) +- *Type:* software.amazon.awscdk.services.iam.IUser The IAM user to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuthMapping\`](#software.amazon.awscdk.services.eks.AwsAuthMapping) +- *Type:* software.amazon.awscdk.services.eks.AwsAuthMapping Mapping to k8s user name and groups. @@ -35529,15 +32420,15 @@ Mapping to k8s user name and groups. -### CfnAddon +### CfnAddon -- *Implements:* [\`software.amazon.awscdk.IInspectable\`](#software.amazon.awscdk.IInspectable) +- *Implements:* software.amazon.awscdk.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnAddon; @@ -35554,36 +32445,36 @@ CfnAddon.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnaddonparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnaddonparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropsparameteraddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropsparameteraddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropsparametertags) | java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> | \`AWS::EKS::Addon.Tags\`. | +| scope | software.constructs.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | java.util.List | \`AWS::EKS::Addon.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`addonName\`Required +##### \`addonName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -35591,9 +32482,9 @@ scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -35601,9 +32492,9 @@ scoped id of the resource. --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -35611,9 +32502,9 @@ scoped id of the resource. --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -35621,9 +32512,9 @@ scoped id of the resource. --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -35631,9 +32522,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::Addon.Tags\`. @@ -35641,60 +32532,60 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.TreeInspector\`](#software.amazon.awscdk.TreeInspector) +- *Type:* software.amazon.awscdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnaddonpropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropertytags)* | [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropertyaddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropertyaddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropertyresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropertyserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.TagManager | \`AWS::EKS::Addon.Tags\`. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) +- *Type:* software.amazon.awscdk.TagManager \`AWS::EKS::Addon.Tags\`. @@ -35702,13 +32593,13 @@ public TagManager getTags(); --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`java public java.lang.String getAddonName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -35716,13 +32607,13 @@ public java.lang.String getAddonName(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -35730,13 +32621,13 @@ public java.lang.String getClusterName(); --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`java public java.lang.String getAddonVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -35744,13 +32635,13 @@ public java.lang.String getAddonVersion(); --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`java public java.lang.String getResolveConflicts(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -35758,13 +32649,13 @@ public java.lang.String getResolveConflicts(); --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`java public java.lang.String getServiceAccountRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -35772,31 +32663,35 @@ public java.lang.String getServiceAccountRoleArn(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnaddonpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`software.amazon.awscdk.IInspectable\`](#software.amazon.awscdk.IInspectable) +- *Implements:* software.amazon.awscdk.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster; @@ -35817,36 +32712,36 @@ CfnCluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnclusterparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnclusterparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterencryptionconfig) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterkubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropsparametername) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| scope | software.constructs.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -35854,9 +32749,9 @@ scoped id of the resource. --- -##### \`roleArn\`Required +##### \`roleArn\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -35864,9 +32759,9 @@ scoped id of the resource. --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -35874,9 +32769,9 @@ scoped id of the resource. --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -35884,9 +32779,9 @@ scoped id of the resource. --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -35894,9 +32789,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -35904,115 +32799,115 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.TreeInspector\`](#software.amazon.awscdk.TreeInspector) +- *Type:* software.amazon.awscdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrCertificateAuthorityData\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrcertificateauthoritydata)* | \`java.lang.String\` | *No description.* | -| [\`attrClusterSecurityGroupId\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrclustersecuritygroupid)* | \`java.lang.String\` | *No description.* | -| [\`attrEncryptionConfigKeyArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`java.lang.String\` | *No description.* | -| [\`attrEndpoint\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrendpoint)* | \`java.lang.String\` | *No description.* | -| [\`attrOpenIdConnectIssuerUrl\`](#softwareamazonawscdkservicesekscfnclusterpropertyattropenidconnectissuerurl)* | \`java.lang.String\` | *No description.* | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertyresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertyencryptionconfig) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertykubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropertyname) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropertyversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| attrArn | java.lang.String | *No description.* | +| attrCertificateAuthorityData | java.lang.String | *No description.* | +| attrClusterSecurityGroupId | java.lang.String | *No description.* | +| attrEncryptionConfigKeyArn | java.lang.String | *No description.* | +| attrEndpoint | java.lang.String | *No description.* | +| attrOpenIdConnectIssuerUrl | java.lang.String | *No description.* | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrCertificateAuthorityData\`Required +##### \`attrCertificateAuthorityData\`Required \`\`\`java public java.lang.String getAttrCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrClusterSecurityGroupId\`Required +##### \`attrClusterSecurityGroupId\`Required \`\`\`java public java.lang.String getAttrClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrEncryptionConfigKeyArn\`Required +##### \`attrEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getAttrEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrEndpoint\`Required +##### \`attrEndpoint\`Required \`\`\`java public java.lang.String getAttrEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrOpenIdConnectIssuerUrl\`Required +##### \`attrOpenIdConnectIssuerUrl\`Required \`\`\`java public java.lang.String getAttrOpenIdConnectIssuerUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`java public java.lang.Object getResourcesVpcConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -36020,13 +32915,13 @@ public java.lang.Object getResourcesVpcConfig(); --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`java public java.lang.String getRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -36034,13 +32929,13 @@ public java.lang.String getRoleArn(); --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`java public java.lang.Object getEncryptionConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -36048,13 +32943,13 @@ public java.lang.Object getEncryptionConfig(); --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`java public java.lang.Object getKubernetesNetworkConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -36062,13 +32957,13 @@ public java.lang.Object getKubernetesNetworkConfig(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -36076,13 +32971,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -36090,31 +32985,35 @@ public java.lang.String getVersion(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnclusterpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`software.amazon.awscdk.IInspectable\`](#software.amazon.awscdk.IInspectable) +- *Implements:* software.amazon.awscdk.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile; @@ -36133,36 +33032,36 @@ CfnFargateProfile.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnfargateprofileparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnfargateprofileparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterpodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterselectors)* | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparametersubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparametertags) | java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> | \`AWS::EKS::FargateProfile.Tags\`. | +| scope | software.constructs.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | java.util.List | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -36170,9 +33069,9 @@ scoped id of the resource. --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -36180,9 +33079,9 @@ scoped id of the resource. --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -36190,9 +33089,9 @@ scoped id of the resource. --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -36200,9 +33099,9 @@ scoped id of the resource. --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -36210,9 +33109,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Tags\`. @@ -36220,60 +33119,60 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.TreeInspector\`](#software.amazon.awscdk.TreeInspector) +- *Type:* software.amazon.awscdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertytags)* | [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertypodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyselectors)* | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertysubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) +- *Type:* software.amazon.awscdk.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -36281,13 +33180,13 @@ public TagManager getTags(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -36295,13 +33194,13 @@ public java.lang.String getClusterName(); --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`java public java.lang.String getPodExecutionRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -36309,13 +33208,13 @@ public java.lang.String getPodExecutionRoleArn(); --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.lang.Object getSelectors(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -36323,13 +33222,13 @@ public java.lang.Object getSelectors(); --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -36337,13 +33236,13 @@ public java.lang.String getFargateProfileName(); --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -36351,31 +33250,35 @@ public java.util.List getSubnets(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`software.amazon.awscdk.IInspectable\`](#software.amazon.awscdk.IInspectable) +- *Implements:* software.amazon.awscdk.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup; @@ -36409,47 +33312,47 @@ CfnNodegroup.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnnodegroupparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnnodegroupparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameternoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametersubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameteramitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametercapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterdisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterlabels) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterlaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameternodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametertags) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametertaints) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| scope | software.constructs.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | java.lang.Object | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -36457,9 +33360,9 @@ scoped id of the resource. --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -36467,9 +33370,9 @@ scoped id of the resource. --- -##### \`subnets\`Required +##### \`subnets\`Required -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -36477,9 +33380,9 @@ scoped id of the resource. --- -##### \`amiType\`Optional +##### \`amiType\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -36487,9 +33390,9 @@ scoped id of the resource. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -36497,9 +33400,9 @@ scoped id of the resource. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -36507,9 +33410,9 @@ scoped id of the resource. --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -36517,9 +33420,9 @@ scoped id of the resource. --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -36527,9 +33430,9 @@ scoped id of the resource. --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -36537,9 +33440,9 @@ scoped id of the resource. --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -36547,9 +33450,9 @@ scoped id of the resource. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -36557,9 +33460,9 @@ scoped id of the resource. --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -36567,9 +33470,9 @@ scoped id of the resource. --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -36577,9 +33480,9 @@ scoped id of the resource. --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -36587,9 +33490,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Tags\`. @@ -36597,9 +33500,9 @@ scoped id of the resource. --- -##### \`taints\`Optional +##### \`taints\`Optional -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -36607,9 +33510,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -36617,93 +33520,93 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.TreeInspector\`](#software.amazon.awscdk.TreeInspector) +- *Type:* software.amazon.awscdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrClusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrclustername)* | \`java.lang.String\` | *No description.* | -| [\`attrNodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrnodegroupname)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropertytags)* | [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropertylabels)* | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropertynoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropertysubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyamitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropertycapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropertydisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropertylaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertynodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropertytaints) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| attrArn | java.lang.String | *No description.* | +| attrClusterName | java.lang.String | *No description.* | +| attrNodegroupName | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| taints | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrClusterName\`Required +##### \`attrClusterName\`Required \`\`\`java public java.lang.String getAttrClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrNodegroupName\`Required +##### \`attrNodegroupName\`Required \`\`\`java public java.lang.String getAttrNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) +- *Type:* software.amazon.awscdk.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -36711,13 +33614,13 @@ public TagManager getTags(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -36725,13 +33628,13 @@ public java.lang.String getClusterName(); --- -##### \`labels\`Required +##### \`labels\`Required \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -36739,13 +33642,13 @@ public java.lang.Object getLabels(); --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`java public java.lang.String getNodeRole(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -36753,13 +33656,13 @@ public java.lang.String getNodeRole(); --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -36767,13 +33670,13 @@ public java.util.List getSubnets(); --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public java.lang.String getAmiType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -36781,13 +33684,13 @@ public java.lang.String getAmiType(); --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public java.lang.String getCapacityType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -36795,13 +33698,13 @@ public java.lang.String getCapacityType(); --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -36809,13 +33712,13 @@ public java.lang.Number getDiskSize(); --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`java public java.lang.Object getForceUpdateEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -36823,13 +33726,13 @@ public java.lang.Object getForceUpdateEnabled(); --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -36837,13 +33740,13 @@ public java.util.List getInstanceTypes(); --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`java public java.lang.Object getLaunchTemplate(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -36851,13 +33754,13 @@ public java.lang.Object getLaunchTemplate(); --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -36865,13 +33768,13 @@ public java.lang.String getNodegroupName(); --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -36879,13 +33782,13 @@ public java.lang.String getReleaseVersion(); --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public java.lang.Object getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -36893,13 +33796,13 @@ public java.lang.Object getRemoteAccess(); --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`java public java.lang.Object getScalingConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -36907,13 +33810,13 @@ public java.lang.Object getScalingConfig(); --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`java public java.lang.Object getTaints(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -36921,13 +33824,13 @@ public java.lang.Object getTaints(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -36935,31 +33838,35 @@ public java.lang.String getVersion(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnnodegrouppropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`java.lang.String\` +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` + +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Implements:* software.amazon.awscdk.services.eks.ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.Cluster; @@ -36992,78 +33899,78 @@ Cluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksclusterparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`id\`](#softwareamazonawscdkserviceseksclusterparameterid)* | \`java.lang.String\` | the id of the Construct to create. | -| [\`version\`](#softwareamazonawscdkserviceseksclusterpropsparameterversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropsparameterclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropsparameterrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusterpropsparametersecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusterpropsparametervpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusterpropsparameterclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusterpropsparametercorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusterpropsparameterendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusterpropsparametermastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusterpropsparameterplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropsparameterprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusterpropsparametersecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacity) | \`java.lang.Number\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`defaultCapacityInstance\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacityinstance) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`defaultCapacityType\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacitytype) | [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) | The default capacity type for the cluster. | +| scope | software.constructs.Construct | a Construct, most likely a cdk.Stack created. | +| id | java.lang.String | the id of the Construct to create. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultCapacity | java.lang.Number | Number of instances to allocate as an initial capacity for this cluster. | +| defaultCapacityInstance | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for the default capacity. | +| defaultCapacityType | software.amazon.awscdk.services.eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id of the Construct to create. --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -37072,36 +33979,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -37110,38 +34017,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -37150,60 +34057,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -37212,18 +34119,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -37232,9 +34139,9 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`defaultCapacityInstance\`Optional +##### \`defaultCapacityInstance\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -37243,233 +34150,233 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`defaultCapacityType\`Optional +##### \`defaultCapacityType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) +- *Type:* software.amazon.awscdk.services.eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAutoScalingGroupCapacity\`](#softwareamazonawscdkserviceseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`addCdk8sChart\`](#softwareamazonawscdkserviceseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addFargateProfile\`](#softwareamazonawscdkserviceseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`addHelmChart\`](#softwareamazonawscdkserviceseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#softwareamazonawscdkserviceseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addNodegroupCapacity\`](#softwareamazonawscdkserviceseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`addServiceAccount\`](#softwareamazonawscdkserviceseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`connectAutoScalingGroupCapacity\`](#softwareamazonawscdkserviceseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`getServiceLoadBalancerAddress\`](#softwareamazonawscdkserviceseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| addAutoScalingGroupCapacity | Add nodes to this EKS cluster. | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addFargateProfile | Adds a Fargate profile to this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addNodegroupCapacity | Add managed nodegroup to this Amazon EKS cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | +| connectAutoScalingGroupCapacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| getServiceLoadBalancerAddress | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`addAutoScalingGroupCapacity\` +##### \`addAutoScalingGroupCapacity\` \`\`\`java public addAutoScalingGroupCapacity(java.lang.String id, AutoScalingGroupCapacityOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions\`](#software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions) +- *Type:* software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`java public addCdk8sChart(java.lang.String id, Construct chart) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the cdk8s chart. --- -##### \`addFargateProfile\` +##### \`addFargateProfile\` \`\`\`java public addFargateProfile(java.lang.String id, FargateProfileOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id of this profile. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions profile options. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`java public addHelmChart(java.lang.String id, HelmChartOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.HelmChartOptions\`](#software.amazon.awscdk.services.eks.HelmChartOptions) +- *Type:* software.amazon.awscdk.services.eks.HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`java public addManifest(java.lang.String id, java.util.Map manifest) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map a list of Kubernetes resource specifications. --- -##### \`addNodegroupCapacity\` +##### \`addNodegroupCapacity\` \`\`\`java public addNodegroupCapacity(java.lang.String id) public addNodegroupCapacity(java.lang.String id, NodegroupOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ID of the nodegroup. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupOptions\`](#software.amazon.awscdk.services.eks.NodegroupOptions) +- *Type:* software.amazon.awscdk.services.eks.NodegroupOptions options for creating a new nodegroup. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`java public addServiceAccount(java.lang.String id) public addServiceAccount(java.lang.String id, ServiceAccountOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceAccountOptions\`](#software.amazon.awscdk.services.eks.ServiceAccountOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceAccountOptions --- -##### \`connectAutoScalingGroupCapacity\` +##### \`connectAutoScalingGroupCapacity\` \`\`\`java public connectAutoScalingGroupCapacity(AutoScalingGroup autoScalingGroup, AutoScalingGroupOptions options) \`\`\` -###### \`autoScalingGroup\`Required +###### \`autoScalingGroup\`Required -- *Type:* [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) +- *Type:* software.amazon.awscdk.services.autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AutoScalingGroupOptions\`](#software.amazon.awscdk.services.eks.AutoScalingGroupOptions) +- *Type:* software.amazon.awscdk.services.eks.AutoScalingGroupOptions options for adding auto scaling groups, like customizing the bootstrap script. --- -##### \`getServiceLoadBalancerAddress\` +##### \`getServiceLoadBalancerAddress\` \`\`\`java public getServiceLoadBalancerAddress(java.lang.String serviceName) public getServiceLoadBalancerAddress(java.lang.String serviceName, ServiceLoadBalancerAddressOptions options) \`\`\` -###### \`serviceName\`Required +###### \`serviceName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the service. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions\`](#software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions Additional operation options. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromClusterAttributes\`](#softwareamazonawscdkserviceseksclusterfromclusterattributes) | Import an existing cluster. | +| fromClusterAttributes | Import an existing cluster. | --- -##### \`fromClusterAttributes\` +##### \`fromClusterAttributes\` \`\`\`java import software.amazon.awscdk.services.eks.Cluster; @@ -37477,68 +34384,68 @@ import software.amazon.awscdk.services.eks.Cluster; Cluster.fromClusterAttributes(Construct scope, java.lang.String id, ClusterAttributes attrs) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the construct scope, in most cases 'this'. --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id or name to import as. --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ClusterAttributes\`](#software.amazon.awscdk.services.eks.ClusterAttributes) +- *Type:* software.amazon.awscdk.services.eks.ClusterAttributes the cluster properties to use for importing information. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`adminRole\`](#softwareamazonawscdkserviceseksclusterpropertyadminrole)* | [\`software.amazon.awscdk.services.iam.Role\`](#software.amazon.awscdk.services.iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`awsAuth\`](#softwareamazonawscdkserviceseksclusterpropertyawsauth)* | [\`software.amazon.awscdk.services.eks.AwsAuth\`](#software.amazon.awscdk.services.eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`clusterArn\`](#softwareamazonawscdkserviceseksclusterpropertyclusterarn)* | \`java.lang.String\` | The AWS generated ARN for the Cluster resource. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksclusterpropertyclustercertificateauthoritydata)* | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksclusterpropertyclusterencryptionconfigkeyarn)* | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksclusterpropertyclusterendpoint)* | \`java.lang.String\` | The endpoint URL for the Cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropertyclustername)* | \`java.lang.String\` | The Name of the created EKS Cluster. | -| [\`clusterOpenIdConnectIssuer\`](#softwareamazonawscdkserviceseksclusterpropertyclusteropenidconnectissuer)* | \`java.lang.String\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`clusterOpenIdConnectIssuerUrl\`](#softwareamazonawscdkserviceseksclusterpropertyclusteropenidconnectissuerurl)* | \`java.lang.String\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`clusterSecurityGroup\`](#softwareamazonawscdkserviceseksclusterpropertyclustersecuritygroup)* | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterpropertyclustersecuritygroupid)* | \`java.lang.String\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`connections\`](#softwareamazonawscdkserviceseksclusterpropertyconnections)* | [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksclusterpropertyopenidconnectprovider)* | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropertyprune)* | \`java.lang.Boolean\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropertyvpc)* | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropertydefaultcapacity) | [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`defaultNodegroup\`](#softwareamazonawscdkserviceseksclusterpropertydefaultnodegroup) | [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropertykubectlenvironment) | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#softwareamazonawscdkserviceseksclusterpropertykubectlprivatesubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#softwareamazonawscdkserviceseksclusterpropertykubectlrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#softwareamazonawscdkserviceseksclusterpropertykubectlsecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| adminRole | software.amazon.awscdk.services.iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| awsAuth | software.amazon.awscdk.services.eks.AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| clusterArn | java.lang.String | The AWS generated ARN for the Cluster resource. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The endpoint URL for the Cluster. | +| clusterName | java.lang.String | The Name of the created EKS Cluster. | +| clusterOpenIdConnectIssuer | java.lang.String | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| clusterOpenIdConnectIssuerUrl | java.lang.String | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| clusterSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | java.lang.String | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| connections | software.amazon.awscdk.services.ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| prune | java.lang.Boolean | Determines if Kubernetes resources can be pruned automatically. | +| role | software.amazon.awscdk.services.iam.IRole | IAM role assumed by the EKS Control Plane. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | +| defaultCapacity | software.amazon.awscdk.services.autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| defaultNodegroup | software.amazon.awscdk.services.eks.Nodegroup | The node group that hosts the default capacity for this cluster. | +| kubectlEnvironment | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| kubectlPrivateSubnets | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | software.amazon.awscdk.services.iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`adminRole\`Required +##### \`adminRole\`Required \`\`\`java public Role getAdminRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.Role\`](#software.amazon.awscdk.services.iam.Role) +- *Type:* software.amazon.awscdk.services.iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -37546,61 +34453,61 @@ This role also has \`systems:master\` permissions. --- -##### \`awsAuth\`Required +##### \`awsAuth\`Required \`\`\`java public AwsAuth getAwsAuth(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuth\`](#software.amazon.awscdk.services.eks.AwsAuth) +- *Type:* software.amazon.awscdk.services.eks.AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`java public java.lang.String getClusterArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The AWS generated ARN for the Cluster resource. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The endpoint URL for the Cluster. @@ -37608,25 +34515,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Name of the created EKS Cluster. --- -##### \`clusterOpenIdConnectIssuer\`Required +##### \`clusterOpenIdConnectIssuer\`Required \`\`\`java public java.lang.String getClusterOpenIdConnectIssuer(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -37634,13 +34541,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterOpenIdConnectIssuerUrl\`Required +##### \`clusterOpenIdConnectIssuerUrl\`Required \`\`\`java public java.lang.String getClusterOpenIdConnectIssuerUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -37648,49 +34555,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`java public ISecurityGroup getClusterSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`java public Connections getConnections(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) +- *Type:* software.amazon.awscdk.services.ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -37698,49 +34605,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean Determines if Kubernetes resources can be pruned automatically. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc The VPC in which this Cluster was created. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`java public AutoScalingGroup getDefaultCapacity(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) +- *Type:* software.amazon.awscdk.services.autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -37748,13 +34655,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`defaultNodegroup\`Optional +##### \`defaultNodegroup\`Optional \`\`\`java public Nodegroup getDefaultNodegroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup) +- *Type:* software.amazon.awscdk.services.eks.Nodegroup The node group that hosts the default capacity for this cluster. @@ -37762,25 +34669,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -37788,38 +34695,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> +- *Type:* java.util.List - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`java public IRole getKubectlRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -37827,13 +34734,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`java public ISecurityGroup getKubectlSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -37841,13 +34748,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.FargateCluster; @@ -37878,72 +34785,72 @@ FargateCluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksfargateclusterparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksfargateclusterparameterid)* | \`java.lang.String\` | *No description.* | -| [\`version\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametersecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametervpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametercorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametermastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametersecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultProfile\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterdefaultprofile) | [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultProfile | software.amazon.awscdk.services.eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -37952,36 +34859,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -37990,38 +34897,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -38030,60 +34937,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -38092,18 +34999,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultProfile\`Optional +##### \`defaultProfile\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. @@ -38114,15 +35021,15 @@ Fargate Profile to create along with the cluster. -### FargateProfile +### FargateProfile -- *Implements:* [\`software.amazon.awscdk.ITaggable\`](#software.amazon.awscdk.ITaggable) +- *Implements:* software.amazon.awscdk.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.FargateProfile; @@ -38139,32 +35046,32 @@ FargateProfile.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksfargateprofileparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksfargateprofileparameterid)* | \`java.lang.String\` | *No description.* | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterpodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametersubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametercluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -38172,31 +35079,31 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -38205,9 +35112,9 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -38216,9 +35123,9 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -38228,48 +35135,48 @@ The EKS cluster to apply the Fargate profile to. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`fargateProfileArn\`](#softwareamazonawscdkserviceseksfargateprofilepropertyfargateprofilearn)* | \`java.lang.String\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropertyfargateprofilename)* | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropertypodexecutionrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`tags\`](#softwareamazonawscdkserviceseksfargateprofilepropertytags)* | [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) | Resource tags. | +| fargateProfileArn | java.lang.String | The full Amazon Resource Name (ARN) of the Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| tags | software.amazon.awscdk.TagManager | Resource tags. | --- -##### \`fargateProfileArn\`Required +##### \`fargateProfileArn\`Required \`\`\`java public java.lang.String getFargateProfileArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`fargateProfileName\`Required +##### \`fargateProfileName\`Required \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the Fargate profile. --- -##### \`podExecutionRole\`Required +##### \`podExecutionRole\`Required \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -38277,26 +35184,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.TagManager\`](#software.amazon.awscdk.TagManager) +- *Type:* software.amazon.awscdk.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.HelmChart; @@ -38317,71 +35224,71 @@ HelmChart.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekshelmchartparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekshelmchartparameterid)* | \`java.lang.String\` | *No description.* | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartpropsparameterchart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartpropsparametercreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartpropsparameternamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartpropsparameterrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartpropsparameterrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartpropsparametertimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartpropsparametervalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartpropsparameterversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartpropsparameterwait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#softwareamazonawscdkservicesekshelmchartpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this configuration to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`chart\`Required +##### \`chart\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -38390,9 +35297,9 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -38401,36 +35308,36 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this configuration to. @@ -38441,29 +35348,33 @@ The EKS cluster to apply this configuration to. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekshelmchartpropertyresourcetype)* | \`java.lang.String\` | The CloudFormation resource type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation resource type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifest; @@ -38479,53 +35390,53 @@ KubernetesManifest.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetesmanifestparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetesmanifestparameterid)* | \`java.lang.String\` | *No description.* | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameterprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameterskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparametermanifest)* | java.util.List> | The manifest to apply. | -| [\`overwrite\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameteroverwrite) | \`java.lang.Boolean\` | Overwrite any existing resources. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this manifest to. | +| manifest | java.util.List> | The manifest to apply. | +| overwrite | java.lang.Boolean | Overwrite any existing resources. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this manifest to. @@ -38533,9 +35444,9 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required -- *Type:* java.util.List> +- *Type:* java.util.List> The manifest to apply. @@ -38543,9 +35454,9 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Overwrite any existing resources. @@ -38557,29 +35468,33 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekskubernetesmanifestpropertyresourcetype)* | \`java.lang.String\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesObjectValue; @@ -38596,32 +35511,32 @@ KubernetesObjectValue.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetesobjectvalueparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetesobjectvalueparameterid)* | \`java.lang.String\` | *No description.* | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`jsonPath\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterjsonpath)* | \`java.lang.String\` | JSONPath to the specific value. | -| [\`objectName\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjectname)* | \`java.lang.String\` | The name of the object to query. | -| [\`objectType\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjecttype)* | \`java.lang.String\` | The object type to query. | -| [\`objectNamespace\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjectnamespace) | \`java.lang.String\` | The namespace the object belongs to. | -| [\`timeout\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparametertimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Timeout for waiting on a value. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to fetch attributes from. | +| jsonPath | java.lang.String | JSONPath to the specific value. | +| objectName | java.lang.String | The name of the object to query. | +| objectType | java.lang.String | The object type to query. | +| objectNamespace | java.lang.String | The namespace the object belongs to. | +| timeout | software.amazon.awscdk.Duration | Timeout for waiting on a value. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to fetch attributes from. @@ -38629,27 +35544,27 @@ The EKS cluster to fetch attributes from. --- -##### \`jsonPath\`Required +##### \`jsonPath\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`objectName\`Required +##### \`objectName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the object to query. --- -##### \`objectType\`Required +##### \`objectType\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The object type to query. @@ -38657,18 +35572,18 @@ The object type to query. --- -##### \`objectNamespace\`Optional +##### \`objectNamespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. @@ -38677,49 +35592,53 @@ Timeout for waiting on a value. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`value\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropertyvalue)* | \`java.lang.String\` | The value as a string token. | +| value | java.lang.String | The value as a string token. | --- -##### \`value\`Required +##### \`value\`Required \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropertyresourcetype)* | \`java.lang.String\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesPatch; @@ -38736,40 +35655,40 @@ KubernetesPatch.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetespatchparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetespatchparameterid)* | \`java.lang.String\` | *No description.* | -| [\`applyPatch\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterapplypatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetespatchpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | -| [\`resourceName\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterresourcename)* | \`java.lang.String\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restorePatch\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterrestorepatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patchType\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterpatchtype) | [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resourceNamespace\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterresourcenamespace) | \`java.lang.String\` | The kubernetes API namespace. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| applyPatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | +| resourceName | java.lang.String | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restorePatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patchType | software.amazon.awscdk.services.eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| resourceNamespace | java.lang.String | The kubernetes API namespace. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`applyPatch\`Required +##### \`applyPatch\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. @@ -38777,25 +35696,25 @@ The cluster to apply the patch to. --- -##### \`resourceName\`Required +##### \`resourceName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restorePatch\`Required +##### \`restorePatch\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patchType\`Optional +##### \`patchType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) +- *Type:* software.amazon.awscdk.services.eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -38804,9 +35723,9 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resourceNamespace\`Optional +##### \`resourceNamespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The kubernetes API namespace. @@ -38817,13 +35736,13 @@ The kubernetes API namespace. -### Nodegroup +### Nodegroup -- *Implements:* [\`software.amazon.awscdk.services.eks.INodegroup\`](#software.amazon.awscdk.services.eks.INodegroup) +- *Implements:* software.amazon.awscdk.services.eks.INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.Nodegroup; @@ -38851,61 +35770,61 @@ Nodegroup.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksnodegroupparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksnodegroupparameterid)* | \`java.lang.String\` | *No description.* | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegrouppropsparameteramitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegrouppropsparametercapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterdesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterdisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterlabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterlaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparametermaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropsparameternodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegrouppropsparameternoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegrouppropsparametersubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegrouppropsparametertags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | Cluster resource. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | software.amazon.awscdk.services.eks.ICluster | Cluster resource. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`amiType\`Optional +##### \`amiType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -38914,18 +35833,18 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -38934,40 +35853,40 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -38976,9 +35895,9 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -38987,18 +35906,18 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -39007,18 +35926,18 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -39027,9 +35946,9 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -39038,9 +35957,9 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -39049,24 +35968,24 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster Cluster resource. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromNodegroupName\`](#softwareamazonawscdkserviceseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| fromNodegroupName | Import the Nodegroup from attributes. | --- -##### \`fromNodegroupName\` +##### \`fromNodegroupName\` \`\`\`java import software.amazon.awscdk.services.eks.Nodegroup; @@ -39074,93 +35993,93 @@ import software.amazon.awscdk.services.eks.Nodegroup; Nodegroup.fromNodegroupName(Construct scope, java.lang.String id, java.lang.String nodegroupName) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`nodegroupName\`Required +###### \`nodegroupName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | the Amazon EKS cluster resource. | -| [\`nodegroupArn\`](#softwareamazonawscdkserviceseksnodegrouppropertynodegrouparn)* | \`java.lang.String\` | ARN of the nodegroup. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropertynodegroupname)* | \`java.lang.String\` | Nodegroup name. | -| [\`role\`](#softwareamazonawscdkserviceseksnodegrouppropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | IAM role of the instance profile for the nodegroup. | +| cluster | software.amazon.awscdk.services.eks.ICluster | the Amazon EKS cluster resource. | +| nodegroupArn | java.lang.String | ARN of the nodegroup. | +| nodegroupName | java.lang.String | Nodegroup name. | +| role | software.amazon.awscdk.services.iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster the Amazon EKS cluster resource. --- -##### \`nodegroupArn\`Required +##### \`nodegroupArn\`Required \`\`\`java public java.lang.String getNodegroupArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String ARN of the nodegroup. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Nodegroup name. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.OpenIdConnectProvider; @@ -39172,31 +36091,31 @@ OpenIdConnectProvider.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksopenidconnectproviderparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | The definition scope. | -| [\`id\`](#softwareamazonawscdkserviceseksopenidconnectproviderparameterid)* | \`java.lang.String\` | Construct ID. | -| [\`url\`](#softwareamazonawscdkserviceseksopenidconnectproviderpropsparameterurl)* | \`java.lang.String\` | The URL of the identity provider. | +| scope | software.constructs.Construct | The definition scope. | +| id | java.lang.String | Construct ID. | +| url | java.lang.String | The URL of the identity provider. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct The definition scope. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Construct ID. --- -##### \`url\`Required +##### \`url\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URL of the identity provider. @@ -39208,13 +36127,13 @@ The URL must begin with https:// and should correspond to the iss claim in the p -### ServiceAccount +### ServiceAccount -- *Implements:* [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) +- *Implements:* software.amazon.awscdk.services.iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccount; @@ -39228,166 +36147,166 @@ ServiceAccount.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksserviceaccountparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksserviceaccountparameterid)* | \`java.lang.String\` | *No description.* | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountpropsparametername) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountpropsparameternamespace) | \`java.lang.String\` | The namespace of the service account. | -| [\`cluster\`](#softwareamazonawscdkserviceseksserviceaccountpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToPrincipalPolicy\`](#softwareamazonawscdkserviceseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| addToPrincipalPolicy | Add to the policy of this principal. | --- -##### \`addToPrincipalPolicy\` +##### \`addToPrincipalPolicy\` \`\`\`java public addToPrincipalPolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`assumeRoleAction\`](#softwareamazonawscdkserviceseksserviceaccountpropertyassumeroleaction)* | \`java.lang.String\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`grantPrincipal\`](#softwareamazonawscdkserviceseksserviceaccountpropertygrantprincipal)* | [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) | The principal to grant permissions to. | -| [\`policyFragment\`](#softwareamazonawscdkserviceseksserviceaccountpropertypolicyfragment)* | [\`software.amazon.awscdk.services.iam.PrincipalPolicyFragment\`](#software.amazon.awscdk.services.iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`role\`](#softwareamazonawscdkserviceseksserviceaccountpropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The role which is linked to the service account. | -| [\`serviceAccountName\`](#softwareamazonawscdkserviceseksserviceaccountpropertyserviceaccountname)* | \`java.lang.String\` | The name of the service account. | -| [\`serviceAccountNamespace\`](#softwareamazonawscdkserviceseksserviceaccountpropertyserviceaccountnamespace)* | \`java.lang.String\` | The namespace where the service account is located in. | +| assumeRoleAction | java.lang.String | When this Principal is used in an AssumeRole policy, the action to use. | +| grantPrincipal | software.amazon.awscdk.services.iam.IPrincipal | The principal to grant permissions to. | +| policyFragment | software.amazon.awscdk.services.iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| role | software.amazon.awscdk.services.iam.IRole | The role which is linked to the service account. | +| serviceAccountName | java.lang.String | The name of the service account. | +| serviceAccountNamespace | java.lang.String | The namespace where the service account is located in. | --- -##### \`assumeRoleAction\`Required +##### \`assumeRoleAction\`Required \`\`\`java public java.lang.String getAssumeRoleAction(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`grantPrincipal\`Required +##### \`grantPrincipal\`Required \`\`\`java public IPrincipal getGrantPrincipal(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) +- *Type:* software.amazon.awscdk.services.iam.IPrincipal The principal to grant permissions to. --- -##### \`policyFragment\`Required +##### \`policyFragment\`Required \`\`\`java public PrincipalPolicyFragment getPolicyFragment(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.PrincipalPolicyFragment\`](#software.amazon.awscdk.services.iam.PrincipalPolicyFragment) +- *Type:* software.amazon.awscdk.services.iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The role which is linked to the service account. --- -##### \`serviceAccountName\`Required +##### \`serviceAccountName\`Required \`\`\`java public java.lang.String getServiceAccountName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the service account. --- -##### \`serviceAccountNamespace\`Required +##### \`serviceAccountNamespace\`Required \`\`\`java public java.lang.String getServiceAccountNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions; @@ -39422,72 +36341,72 @@ AutoScalingGroupCapacityOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`allowAllOutbound\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`java.lang.Boolean\` | Whether the instances can initiate connections to anywhere by default. | -| [\`associatePublicIpAddress\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`java.lang.Boolean\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`autoScalingGroupName\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`java.lang.String\` | The name of the Auto Scaling group. | -| [\`blockDevices\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyblockdevices) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.BlockDevice\`](#software.amazon.awscdk.services.autoscaling.BlockDevice)> | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`cooldown\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertycooldown) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`desiredCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`java.lang.Number\` | Initial amount of instances in the fleet. | -| [\`groupMetrics\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertygroupmetrics) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.GroupMetrics\`](#software.amazon.awscdk.services.autoscaling.GroupMetrics)> | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`healthCheck\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`software.amazon.awscdk.services.autoscaling.HealthCheck\`](#software.amazon.awscdk.services.autoscaling.HealthCheck) | Configuration for health checks. | -| [\`ignoreUnmodifiedSizeProperties\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`java.lang.Boolean\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`instanceMonitoring\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`software.amazon.awscdk.services.autoscaling.Monitoring\`](#software.amazon.awscdk.services.autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`keyName\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertykeyname) | \`java.lang.String\` | Name of SSH keypair to grant access to instances. | -| [\`maxCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`java.lang.Number\` | Maximum number of instances in the fleet. | -| [\`maxInstanceLifetime\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | The maximum amount of time that an instance can be in service. | -| [\`minCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymincapacity) | \`java.lang.Number\` | Minimum number of instances in the fleet. | -| [\`newInstancesProtectedFromScaleIn\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`java.lang.Boolean\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`notifications\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertynotifications) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.NotificationConfiguration\`](#software.amazon.awscdk.services.autoscaling.NotificationConfiguration)> | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`signals\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertysignals) | [\`software.amazon.awscdk.services.autoscaling.Signals\`](#software.amazon.awscdk.services.autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`spotPrice\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyspotprice) | \`java.lang.String\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`updatePolicy\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`software.amazon.awscdk.services.autoscaling.UpdatePolicy\`](#software.amazon.awscdk.services.autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`instanceType\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | Instance type of the instances to start. | -| [\`bootstrapEnabled\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`java.lang.Boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`machineImageType\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) | Machine image type. | -| [\`mapRole\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaprole) | \`java.lang.Boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`java.lang.Boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| allowAllOutbound | java.lang.Boolean | Whether the instances can initiate connections to anywhere by default. | +| associatePublicIpAddress | java.lang.Boolean | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| autoScalingGroupName | java.lang.String | The name of the Auto Scaling group. | +| blockDevices | java.util.List | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| cooldown | software.amazon.awscdk.Duration | Default scaling cooldown for this AutoScalingGroup. | +| desiredCapacity | java.lang.Number | Initial amount of instances in the fleet. | +| groupMetrics | java.util.List | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| healthCheck | software.amazon.awscdk.services.autoscaling.HealthCheck | Configuration for health checks. | +| ignoreUnmodifiedSizeProperties | java.lang.Boolean | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| instanceMonitoring | software.amazon.awscdk.services.autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| keyName | java.lang.String | Name of SSH keypair to grant access to instances. | +| maxCapacity | java.lang.Number | Maximum number of instances in the fleet. | +| maxInstanceLifetime | software.amazon.awscdk.Duration | The maximum amount of time that an instance can be in service. | +| minCapacity | java.lang.Number | Minimum number of instances in the fleet. | +| newInstancesProtectedFromScaleIn | java.lang.Boolean | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| notifications | java.util.List | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| signals | software.amazon.awscdk.services.autoscaling.Signals | Configure waiting for signals during deployment. | +| spotPrice | java.lang.String | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| updatePolicy | software.amazon.awscdk.services.autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | Where to place instances within the VPC. | +| instanceType | software.amazon.awscdk.services.ec2.InstanceType | Instance type of the instances to start. | +| bootstrapEnabled | java.lang.Boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | software.amazon.awscdk.services.eks.BootstrapOptions | EKS node bootstrapping options. | +| machineImageType | software.amazon.awscdk.services.eks.MachineImageType | Machine image type. | +| mapRole | java.lang.Boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | java.lang.Boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`allowAllOutbound\`Optional +##### \`allowAllOutbound\`Optional \`\`\`java public java.lang.Boolean getAllowAllOutbound(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`associatePublicIpAddress\`Optional +##### \`associatePublicIpAddress\`Optional \`\`\`java public java.lang.Boolean getAssociatePublicIpAddress(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`autoScalingGroupName\`Optional +##### \`autoScalingGroupName\`Optional \`\`\`java public java.lang.String getAutoScalingGroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -39496,60 +36415,60 @@ This name must be unique per Region per account. --- -##### \`blockDevices\`Optional +##### \`blockDevices\`Optional \`\`\`java public java.util.List getBlockDevices(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.BlockDevice\`](#software.amazon.awscdk.services.autoscaling.BlockDevice)> +- *Type:* java.util.List - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`cooldown\`Optional +##### \`cooldown\`Optional \`\`\`java public Duration getCooldown(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`desiredCapacity\`Optional +##### \`desiredCapacity\`Optional \`\`\`java public java.lang.Number getDesiredCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`groupMetrics\`Optional +##### \`groupMetrics\`Optional \`\`\`java public java.util.List getGroupMetrics(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.GroupMetrics\`](#software.amazon.awscdk.services.autoscaling.GroupMetrics)> +- *Type:* java.util.List - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -39558,26 +36477,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`healthCheck\`Optional +##### \`healthCheck\`Optional \`\`\`java public HealthCheck getHealthCheck(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.HealthCheck\`](#software.amazon.awscdk.services.autoscaling.HealthCheck) +- *Type:* software.amazon.awscdk.services.autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`ignoreUnmodifiedSizeProperties\`Optional +##### \`ignoreUnmodifiedSizeProperties\`Optional \`\`\`java public java.lang.Boolean getIgnoreUnmodifiedSizeProperties(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -39586,86 +36505,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`instanceMonitoring\`Optional +##### \`instanceMonitoring\`Optional \`\`\`java public Monitoring getInstanceMonitoring(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.Monitoring\`](#software.amazon.awscdk.services.autoscaling.Monitoring) +- *Type:* software.amazon.awscdk.services.autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`keyName\`Optional +##### \`keyName\`Optional \`\`\`java public java.lang.String getKeyName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`maxCapacity\`Optional +##### \`maxCapacity\`Optional \`\`\`java public java.lang.Number getMaxCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`maxInstanceLifetime\`Optional +##### \`maxInstanceLifetime\`Optional \`\`\`java public Duration getMaxInstanceLifetime(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`minCapacity\`Optional +##### \`minCapacity\`Optional \`\`\`java public java.lang.Number getMinCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`newInstancesProtectedFromScaleIn\`Optional +##### \`newInstancesProtectedFromScaleIn\`Optional \`\`\`java public java.lang.Boolean getNewInstancesProtectedFromScaleIn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -39674,28 +36593,28 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`notifications\`Optional +##### \`notifications\`Optional \`\`\`java public java.util.List getNotifications(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.NotificationConfiguration\`](#software.amazon.awscdk.services.autoscaling.NotificationConfiguration)> +- *Type:* java.util.List - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### \`signals\`Optional +##### \`signals\`Optional \`\`\`java public Signals getSignals(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.Signals\`](#software.amazon.awscdk.services.autoscaling.Signals) +- *Type:* software.amazon.awscdk.services.autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -39704,13 +36623,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`spotPrice\`Optional +##### \`spotPrice\`Optional \`\`\`java public java.lang.String getSpotPrice(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -39719,13 +36638,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`updatePolicy\`Optional +##### \`updatePolicy\`Optional \`\`\`java public UpdatePolicy getUpdatePolicy(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.UpdatePolicy\`](#software.amazon.awscdk.services.autoscaling.UpdatePolicy) +- *Type:* software.amazon.awscdk.services.autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -39734,38 +36653,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public SubnetSelection getVpcSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`instanceType\`Required +##### \`instanceType\`Required \`\`\`java public InstanceType getInstanceType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType Instance type of the instances to start. --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`java public java.lang.Boolean getBootstrapEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -39774,39 +36693,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`java public BootstrapOptions getBootstrapOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) +- *Type:* software.amazon.awscdk.services.eks.BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`java public MachineImageType getMachineImageType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) +- *Type:* software.amazon.awscdk.services.eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`java public java.lang.Boolean getMapRole(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -39815,13 +36734,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`java public java.lang.Boolean getSpotInterruptHandler(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -39830,11 +36749,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AutoScalingGroupOptions; @@ -39848,25 +36767,25 @@ AutoScalingGroupOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`bootstrapEnabled\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertybootstrapenabled) | \`java.lang.Boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertybootstrapoptions) | [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`machineImageType\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertymachineimagetype) | [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`mapRole\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertymaprole) | \`java.lang.Boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`java.lang.Boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| bootstrapEnabled | java.lang.Boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | software.amazon.awscdk.services.eks.BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| machineImageType | software.amazon.awscdk.services.eks.MachineImageType | Allow options to specify different machine image type. | +| mapRole | java.lang.Boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | java.lang.Boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`java public java.lang.Boolean getBootstrapEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -39875,39 +36794,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`java public BootstrapOptions getBootstrapOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) +- *Type:* software.amazon.awscdk.services.eks.BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`java public MachineImageType getMachineImageType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) +- *Type:* software.amazon.awscdk.services.eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`java public java.lang.Boolean getMapRole(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -39916,13 +36835,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`java public java.lang.Boolean getSpotInterruptHandler(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -39931,11 +36850,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AwsAuthMapping; @@ -39946,47 +36865,47 @@ AwsAuthMapping.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`groups\`](#softwareamazonawscdkserviceseksawsauthmappingpropertygroups)* | java.util.List<\`java.lang.String\`> | A list of groups within Kubernetes to which the role is mapped. | -| [\`username\`](#softwareamazonawscdkserviceseksawsauthmappingpropertyusername) | \`java.lang.String\` | The user name within Kubernetes to map to the IAM role. | +| groups | java.util.List | A list of groups within Kubernetes to which the role is mapped. | +| username | java.lang.String | The user name within Kubernetes to map to the IAM role. | --- -##### \`groups\`Required +##### \`groups\`Required \`\`\`java public java.util.List getGroups(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`username\`Optional +##### \`username\`Optional \`\`\`java public java.lang.String getUsername(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AwsAuthProps; @@ -39996,21 +36915,21 @@ AwsAuthProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkserviceseksawsauthpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply this configuration to. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public Cluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply this configuration to. @@ -40018,11 +36937,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.BootstrapOptions; @@ -40038,94 +36957,94 @@ BootstrapOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`additionalArgs\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyadditionalargs) | \`java.lang.String\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`awsApiRetryAttempts\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyawsapiretryattempts) | \`java.lang.Number\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`dnsClusterIp\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertydnsclusterip) | \`java.lang.String\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`dockerConfigJson\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertydockerconfigjson) | \`java.lang.String\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`enableDockerBridge\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyenabledockerbridge) | \`java.lang.Boolean\` | Restores the docker default bridge network. | -| [\`kubeletExtraArgs\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertykubeletextraargs) | \`java.lang.String\` | Extra arguments to add to the kubelet. | -| [\`useMaxPods\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyusemaxpods) | \`java.lang.Boolean\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| additionalArgs | java.lang.String | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| awsApiRetryAttempts | java.lang.Number | Number of retry attempts for AWS API call (DescribeCluster). | +| dnsClusterIp | java.lang.String | Overrides the IP address to use for DNS queries within the cluster. | +| dockerConfigJson | java.lang.String | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| enableDockerBridge | java.lang.Boolean | Restores the docker default bridge network. | +| kubeletExtraArgs | java.lang.String | Extra arguments to add to the kubelet. | +| useMaxPods | java.lang.Boolean | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`additionalArgs\`Optional +##### \`additionalArgs\`Optional \`\`\`java public java.lang.String getAdditionalArgs(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`awsApiRetryAttempts\`Optional +##### \`awsApiRetryAttempts\`Optional \`\`\`java public java.lang.Number getAwsApiRetryAttempts(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`dnsClusterIp\`Optional +##### \`dnsClusterIp\`Optional \`\`\`java public java.lang.String getDnsClusterIp(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`dockerConfigJson\`Optional +##### \`dockerConfigJson\`Optional \`\`\`java public java.lang.String getDockerConfigJson(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`enableDockerBridge\`Optional +##### \`enableDockerBridge\`Optional \`\`\`java public java.lang.Boolean getEnableDockerBridge(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Restores the docker default bridge network. --- -##### \`kubeletExtraArgs\`Optional +##### \`kubeletExtraArgs\`Optional \`\`\`java public java.lang.String getKubeletExtraArgs(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none Extra arguments to add to the kubelet. @@ -40134,26 +37053,26 @@ Useful for adding labels or taints. --- -##### \`useMaxPods\`Optional +##### \`useMaxPods\`Optional \`\`\`java public java.lang.Boolean getUseMaxPods(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnAddonProps; @@ -40168,26 +37087,26 @@ CfnAddonProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyaddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyaddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropspropertytags) | java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> | \`AWS::EKS::Addon.Tags\`. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | java.util.List | \`AWS::EKS::Addon.Tags\`. | --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`java public java.lang.String getAddonName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -40195,13 +37114,13 @@ public java.lang.String getAddonName(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -40209,13 +37128,13 @@ public java.lang.String getClusterName(); --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`java public java.lang.String getAddonVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -40223,13 +37142,13 @@ public java.lang.String getAddonVersion(); --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`java public java.lang.String getResolveConflicts(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -40237,13 +37156,13 @@ public java.lang.String getResolveConflicts(); --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`java public java.lang.String getServiceAccountRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -40251,13 +37170,13 @@ public java.lang.String getServiceAccountRoleArn(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::Addon.Tags\`. @@ -40265,13 +37184,13 @@ public java.util.List getTags(); --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnClusterProps; @@ -40290,26 +37209,26 @@ CfnClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyencryptionconfig) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertykubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyname) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`java public java.lang.Object getResourcesVpcConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -40317,13 +37236,13 @@ public java.lang.Object getResourcesVpcConfig(); --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`java public java.lang.String getRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -40331,13 +37250,13 @@ public java.lang.String getRoleArn(); --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`java public java.lang.Object getEncryptionConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -40345,13 +37264,13 @@ public java.lang.Object getEncryptionConfig(); --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`java public java.lang.Object getKubernetesNetworkConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -40359,13 +37278,13 @@ public java.lang.Object getKubernetesNetworkConfig(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -40373,13 +37292,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -40387,13 +37306,13 @@ public java.lang.String getVersion(); --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfileProps; @@ -40410,26 +37329,26 @@ CfnFargateProfileProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyselectors)* | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertysubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertytags) | java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | java.util.List | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -40437,13 +37356,13 @@ public java.lang.String getClusterName(); --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`java public java.lang.String getPodExecutionRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -40451,13 +37370,13 @@ public java.lang.String getPodExecutionRoleArn(); --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.lang.Object getSelectors(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -40465,13 +37384,13 @@ public java.lang.Object getSelectors(); --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -40479,13 +37398,13 @@ public java.lang.String getFargateProfileName(); --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -40493,13 +37412,13 @@ public java.util.List getSubnets(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.CfnTag\`](#software.amazon.awscdk.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Tags\`. @@ -40507,13 +37426,13 @@ public java.util.List getTags(); --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroupProps; @@ -40545,37 +37464,37 @@ CfnNodegroupProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertynoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertysubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyamitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertycapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertydisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertylabels) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertylaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertynodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertytags) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertytaints) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | java.lang.Object | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | software.amazon.awscdk.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -40583,13 +37502,13 @@ public java.lang.String getClusterName(); --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`java public java.lang.String getNodeRole(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -40597,13 +37516,13 @@ public java.lang.String getNodeRole(); --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -40611,13 +37530,13 @@ public java.util.List getSubnets(); --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public java.lang.String getAmiType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -40625,13 +37544,13 @@ public java.lang.String getAmiType(); --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public java.lang.String getCapacityType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -40639,13 +37558,13 @@ public java.lang.String getCapacityType(); --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -40653,13 +37572,13 @@ public java.lang.Number getDiskSize(); --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`java public java.lang.Object getForceUpdateEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -40667,13 +37586,13 @@ public java.lang.Object getForceUpdateEnabled(); --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -40681,13 +37600,13 @@ public java.util.List getInstanceTypes(); --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -40695,13 +37614,13 @@ public java.lang.Object getLabels(); --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`java public java.lang.Object getLaunchTemplate(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -40709,13 +37628,13 @@ public java.lang.Object getLaunchTemplate(); --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -40723,13 +37642,13 @@ public java.lang.String getNodegroupName(); --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -40737,13 +37656,13 @@ public java.lang.String getReleaseVersion(); --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public java.lang.Object getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -40751,13 +37670,13 @@ public java.lang.Object getRemoteAccess(); --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`java public java.lang.Object getScalingConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -40765,13 +37684,13 @@ public java.lang.Object getScalingConfig(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.lang.Object getTags(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Tags\`. @@ -40779,13 +37698,13 @@ public java.lang.Object getTags(); --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`java public java.lang.Object getTaints(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -40793,13 +37712,13 @@ public java.lang.Object getTaints(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -40807,11 +37726,11 @@ public java.lang.String getVersion(); --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterAttributes; @@ -40835,112 +37754,112 @@ ClusterAttributes.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustername)* | \`java.lang.String\` | The physical name of the Cluster. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustercertificateauthoritydata) | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksclusterattributespropertyclusterendpoint) | \`java.lang.String\` | The API Server endpoint URL. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustersecuritygroupid) | \`java.lang.String\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlenvironment) | java.util.Map | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnetIds\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlprivatesubnetids) | java.util.List<\`java.lang.String\`> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRoleArn\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlrolearn) | \`java.lang.String\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`kubectlSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlsecuritygroupid) | \`java.lang.String\` | A security group to use for \`kubectl\` execution. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksclusterattributespropertyopenidconnectprovider) | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterattributespropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`securityGroupIds\`](#softwareamazonawscdkserviceseksclusterattributespropertysecuritygroupids) | java.util.List<\`java.lang.String\`> | Additional security groups associated with this cluster. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterattributespropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | +| clusterName | java.lang.String | The physical name of the Cluster. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The API Server endpoint URL. | +| clusterSecurityGroupId | java.lang.String | The cluster security group that was created by Amazon EKS for the cluster. | +| kubectlEnvironment | java.util.Map | Environment variables to use when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnetIds | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRoleArn | java.lang.String | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| kubectlSecurityGroupId | java.lang.String | A security group to use for \`kubectl\` execution. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| securityGroupIds | java.util.List | Additional security groups associated with this cluster. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The physical name of the Cluster. --- -##### \`clusterCertificateAuthorityData\`Optional +##### \`clusterCertificateAuthorityData\`Optional \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Optional +##### \`clusterEncryptionConfigKeyArn\`Optional \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Optional +##### \`clusterEndpoint\`Optional \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`clusterSecurityGroupId\`Optional +##### \`clusterSecurityGroupId\`Optional \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -40949,26 +37868,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnetIds\`Optional +##### \`kubectlPrivateSubnetIds\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnetIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -40977,26 +37896,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRoleArn\`Optional +##### \`kubectlRoleArn\`Optional \`\`\`java public java.lang.String getKubectlRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`kubectlSecurityGroupId\`Optional +##### \`kubectlSecurityGroupId\`Optional \`\`\`java public java.lang.String getKubectlSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -41005,13 +37924,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`openIdConnectProvider\`Optional +##### \`openIdConnectProvider\`Optional \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -41020,13 +37939,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -41035,37 +37954,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`java public java.util.List getSecurityGroupIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterOptions; @@ -41093,77 +38012,77 @@ ClusterOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksclusteroptionspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusteroptionspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusteroptionspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusteroptionspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusteroptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusteroptionspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusteroptionspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusteroptionspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusteroptionspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusteroptionspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusteroptionspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusteroptionspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -41172,52 +38091,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -41226,54 +38145,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -41282,84 +38201,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -41368,24 +38287,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterProps; @@ -41416,80 +38335,80 @@ ClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksclusterpropspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusterpropspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusterpropspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusterpropspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusterpropspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusterpropspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusterpropspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusterpropspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusterpropspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacity) | \`java.lang.Number\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`defaultCapacityInstance\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacityinstance) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`defaultCapacityType\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacitytype) | [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) | The default capacity type for the cluster. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultCapacity | java.lang.Number | Number of instances to allocate as an initial capacity for this cluster. | +| defaultCapacityInstance | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for the default capacity. | +| defaultCapacityType | software.amazon.awscdk.services.eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -41498,52 +38417,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -41552,54 +38471,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -41608,84 +38527,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -41694,26 +38613,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`java public java.lang.Number getDefaultCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -41722,13 +38641,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`defaultCapacityInstance\`Optional +##### \`defaultCapacityInstance\`Optional \`\`\`java public InstanceType getDefaultCapacityInstance(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -41737,24 +38656,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`defaultCapacityType\`Optional +##### \`defaultCapacityType\`Optional \`\`\`java public DefaultCapacityType getDefaultCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) +- *Type:* software.amazon.awscdk.services.eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CommonClusterOptions; @@ -41771,66 +38690,66 @@ CommonClusterOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -41839,52 +38758,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -41893,11 +38812,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.EksOptimizedImageProps; @@ -41909,60 +38828,60 @@ EksOptimizedImageProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpuArch\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertycpuarch) | [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetesVersion\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertykubernetesversion) | \`java.lang.String\` | The Kubernetes version to use. | -| [\`nodeType\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertynodetype) | [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpuArch | software.amazon.awscdk.services.eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetesVersion | java.lang.String | The Kubernetes version to use. | +| nodeType | software.amazon.awscdk.services.eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpuArch\`Optional +##### \`cpuArch\`Optional \`\`\`java public CpuArch getCpuArch(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) +- *Type:* software.amazon.awscdk.services.eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetesVersion\`Optional +##### \`kubernetesVersion\`Optional \`\`\`java public java.lang.String getKubernetesVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest version The Kubernetes version to use. --- -##### \`nodeType\`Optional +##### \`nodeType\`Optional \`\`\`java public NodeType getNodeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) +- *Type:* software.amazon.awscdk.services.eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty; @@ -41974,22 +38893,22 @@ EncryptionConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`provider\`](#softwareamazonawscdkservicesekscfnclusterencryptionconfigpropertypropertyprovider) | [\`software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`resources\`](#softwareamazonawscdkservicesekscfnclusterencryptionconfigpropertypropertyresources) | java.util.List<\`java.lang.String\`> | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| provider | software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty OR software.amazon.awscdk.IResolvable | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| resources | java.util.List | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`provider\`Optional +##### \`provider\`Optional \`\`\`java public java.lang.Object getProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty OR software.amazon.awscdk.IResolvable \`CfnCluster.EncryptionConfigProperty.Provider\`. @@ -41997,13 +38916,13 @@ public java.lang.Object getProvider(); --- -##### \`resources\`Optional +##### \`resources\`Optional \`\`\`java public java.util.List getResources(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -42011,11 +38930,11 @@ public java.util.List getResources(); --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateClusterProps; @@ -42044,78 +38963,78 @@ FargateClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultProfile\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertydefaultprofile) | [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultProfile | software.amazon.awscdk.services.eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -42124,52 +39043,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -42178,54 +39097,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -42234,84 +39153,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -42320,37 +39239,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultProfile\`Optional +##### \`defaultProfile\`Optional \`\`\`java public FargateProfileOptions getDefaultProfile(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateProfileOptions; @@ -42364,25 +39283,25 @@ FargateProfileOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertypodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertysubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.util.List getSelectors(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -42390,43 +39309,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`java public SubnetSelection getSubnetSelection(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -42435,13 +39354,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -42450,11 +39369,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateProfileProps; @@ -42469,26 +39388,26 @@ FargateProfileProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertypodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertysubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertycluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.util.List getSelectors(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -42496,43 +39415,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`java public SubnetSelection getSubnetSelection(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -42541,13 +39460,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -42556,13 +39475,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public Cluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -42570,11 +39489,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.HelmChartOptions; @@ -42592,80 +39511,80 @@ HelmChartOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartoptionspropertychart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartoptionspropertycreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartoptionspropertynamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartoptionspropertytimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyvalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartoptionspropertywait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`java public java.lang.String getChart(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`java public java.lang.Boolean getCreateNamespace(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`java public java.lang.String getRelease(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`java public java.lang.String getRepository(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -42674,13 +39593,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -42689,50 +39608,50 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`java public java.util.Map getValues(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`java public java.lang.Boolean getWait(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.HelmChartProps; @@ -42751,81 +39670,81 @@ HelmChartProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartpropspropertychart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartpropspropertycreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartpropspropertynamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartpropspropertyrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartpropspropertyrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartpropspropertytimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartpropspropertyvalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartpropspropertyversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartpropspropertywait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#softwareamazonawscdkservicesekshelmchartpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this configuration to. | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`java public java.lang.String getChart(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`java public java.lang.Boolean getCreateNamespace(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`java public java.lang.String getRelease(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`java public java.lang.String getRepository(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -42834,13 +39753,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -42849,52 +39768,52 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`java public java.util.Map getValues(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`java public java.lang.Boolean getWait(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this configuration to. @@ -42902,11 +39821,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifestOptions; @@ -42917,50 +39836,50 @@ KubernetesManifestOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestoptionspropertyprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestoptionspropertyskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`java public java.lang.Boolean getSkipValidation(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifestProps; @@ -42974,55 +39893,55 @@ KubernetesManifestProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertymanifest)* | java.util.List> | The manifest to apply. | -| [\`overwrite\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyoverwrite) | \`java.lang.Boolean\` | Overwrite any existing resources. | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this manifest to. | +| manifest | java.util.List> | The manifest to apply. | +| overwrite | java.lang.Boolean | Overwrite any existing resources. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`java public java.lang.Boolean getSkipValidation(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this manifest to. @@ -43030,13 +39949,13 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required \`\`\`java public java.util.List> getManifest(); \`\`\` -- *Type:* java.util.List> +- *Type:* java.util.List> The manifest to apply. @@ -43044,13 +39963,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional \`\`\`java public java.lang.Boolean getOverwrite(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Overwrite any existing resources. @@ -43059,11 +39978,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty; @@ -43073,21 +39992,21 @@ KubernetesNetworkConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`serviceIpv4Cidr\`](#softwareamazonawscdkservicesekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`java.lang.String\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| serviceIpv4Cidr | java.lang.String | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`serviceIpv4Cidr\`Optional +##### \`serviceIpv4Cidr\`Optional \`\`\`java public java.lang.String getServiceIpv4Cidr(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -43095,11 +40014,11 @@ public java.lang.String getServiceIpv4Cidr(); --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesObjectValueProps; @@ -43114,26 +40033,26 @@ KubernetesObjectValueProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`jsonPath\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyjsonpath)* | \`java.lang.String\` | JSONPath to the specific value. | -| [\`objectName\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjectname)* | \`java.lang.String\` | The name of the object to query. | -| [\`objectType\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjecttype)* | \`java.lang.String\` | The object type to query. | -| [\`objectNamespace\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjectnamespace) | \`java.lang.String\` | The namespace the object belongs to. | -| [\`timeout\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertytimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Timeout for waiting on a value. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to fetch attributes from. | +| jsonPath | java.lang.String | JSONPath to the specific value. | +| objectName | java.lang.String | The name of the object to query. | +| objectType | java.lang.String | The object type to query. | +| objectNamespace | java.lang.String | The namespace the object belongs to. | +| timeout | software.amazon.awscdk.Duration | Timeout for waiting on a value. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to fetch attributes from. @@ -43141,39 +40060,39 @@ The EKS cluster to fetch attributes from. --- -##### \`jsonPath\`Required +##### \`jsonPath\`Required \`\`\`java public java.lang.String getJsonPath(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`objectName\`Required +##### \`objectName\`Required \`\`\`java public java.lang.String getObjectName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the object to query. --- -##### \`objectType\`Required +##### \`objectType\`Required \`\`\`java public java.lang.String getObjectType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The object type to query. @@ -43181,37 +40100,37 @@ The object type to query. --- -##### \`objectNamespace\`Optional +##### \`objectNamespace\`Optional \`\`\`java public java.lang.String getObjectNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesPatchProps; @@ -43226,38 +40145,38 @@ KubernetesPatchProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`applyPatch\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyapplypatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | -| [\`resourceName\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyresourcename)* | \`java.lang.String\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restorePatch\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyrestorepatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patchType\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertypatchtype) | [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resourceNamespace\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyresourcenamespace) | \`java.lang.String\` | The kubernetes API namespace. | +| applyPatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | +| resourceName | java.lang.String | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restorePatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patchType | software.amazon.awscdk.services.eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| resourceNamespace | java.lang.String | The kubernetes API namespace. | --- -##### \`applyPatch\`Required +##### \`applyPatch\`Required \`\`\`java public java.util.Map getApplyPatch(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. @@ -43265,37 +40184,37 @@ The cluster to apply the patch to. --- -##### \`resourceName\`Required +##### \`resourceName\`Required \`\`\`java public java.lang.String getResourceName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restorePatch\`Required +##### \`restorePatch\`Required \`\`\`java public java.util.Map getRestorePatch(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patchType\`Optional +##### \`patchType\`Optional \`\`\`java public PatchType getPatchType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) +- *Type:* software.amazon.awscdk.services.eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -43304,24 +40223,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resourceNamespace\`Optional +##### \`resourceNamespace\`Optional \`\`\`java public java.lang.String getResourceNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty; @@ -43332,22 +40251,22 @@ LabelProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`key\`](#softwareamazonawscdkservicesekscfnfargateprofilelabelpropertypropertykey)* | \`java.lang.String\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`value\`](#softwareamazonawscdkservicesekscfnfargateprofilelabelpropertypropertyvalue)* | \`java.lang.String\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| key | java.lang.String | \`CfnFargateProfile.LabelProperty.Key\`. | +| value | java.lang.String | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`key\`Required +##### \`key\`Required \`\`\`java public java.lang.String getKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.LabelProperty.Key\`. @@ -43355,13 +40274,13 @@ public java.lang.String getKey(); --- -##### \`value\`Required +##### \`value\`Required \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.LabelProperty.Value\`. @@ -43369,11 +40288,11 @@ public java.lang.String getValue(); --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.LaunchTemplateSpec; @@ -43384,45 +40303,45 @@ LaunchTemplateSpec.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#softwareamazonawscdkservicesekslaunchtemplatespecpropertyid)* | \`java.lang.String\` | The Launch template ID. | -| [\`version\`](#softwareamazonawscdkservicesekslaunchtemplatespecpropertyversion) | \`java.lang.String\` | The launch template version to be used (optional). | +| id | java.lang.String | The Launch template ID. | +| version | java.lang.String | The launch template version to be used (optional). | --- -##### \`id\`Required +##### \`id\`Required \`\`\`java public java.lang.String getId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Launch template ID. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty; @@ -43434,23 +40353,23 @@ LaunchTemplateSpecificationProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| id | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| name | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| version | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`id\`Optional +##### \`id\`Optional \`\`\`java public java.lang.String getId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -43458,13 +40377,13 @@ public java.lang.String getId(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -43472,13 +40391,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -43486,11 +40405,11 @@ public java.lang.String getVersion(); --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupOptions; @@ -43515,62 +40434,62 @@ NodegroupOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyamitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertycapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertydesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertydisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertylabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertylaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertymaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertynodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertynoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertysubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertytags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public NodegroupAmiType getAmiType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public CapacityType getCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -43579,26 +40498,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`java public java.lang.Boolean getForceUpdate(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -43607,56 +40526,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`java public LaunchTemplateSpec getLaunchTemplateSpec(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -43665,13 +40584,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -43680,26 +40599,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`java public IRole getNodeRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -43708,26 +40627,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public NodegroupRemoteAccess getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -43736,13 +40655,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public SubnetSelection getSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -43751,13 +40670,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.Map getTags(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -43766,11 +40685,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupProps; @@ -43796,63 +40715,63 @@ NodegroupProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyamitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegrouppropspropertycapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertydesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertydisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegrouppropspropertylabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegrouppropspropertylaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertymaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropspropertynodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegrouppropspropertynoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegrouppropspropertysubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegrouppropspropertytags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | Cluster resource. | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | software.amazon.awscdk.services.eks.ICluster | Cluster resource. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public NodegroupAmiType getAmiType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public CapacityType getCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -43861,26 +40780,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`java public java.lang.Boolean getForceUpdate(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -43889,56 +40808,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`java public LaunchTemplateSpec getLaunchTemplateSpec(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -43947,13 +40866,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -43962,26 +40881,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`java public IRole getNodeRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -43990,26 +40909,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public NodegroupRemoteAccess getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -44018,13 +40937,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public SubnetSelection getSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -44033,13 +40952,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.Map getTags(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -44048,25 +40967,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupRemoteAccess; @@ -44077,34 +40996,34 @@ NodegroupRemoteAccess.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`sshKeyName\`](#softwareamazonawscdkserviceseksnodegroupremoteaccesspropertysshkeyname)* | \`java.lang.String\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`sourceSecurityGroups\`](#softwareamazonawscdkserviceseksnodegroupremoteaccesspropertysourcesecuritygroups) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| sshKeyName | java.lang.String | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| sourceSecurityGroups | java.util.List | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`sshKeyName\`Required +##### \`sshKeyName\`Required \`\`\`java public java.lang.String getSshKeyName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`java public java.util.List getSourceSecurityGroups(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> +- *Type:* java.util.List - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -44113,11 +41032,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.OpenIdConnectProviderProps; @@ -44127,21 +41046,21 @@ OpenIdConnectProviderProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`url\`](#softwareamazonawscdkserviceseksopenidconnectproviderpropspropertyurl)* | \`java.lang.String\` | The URL of the identity provider. | +| url | java.lang.String | The URL of the identity provider. | --- -##### \`url\`Required +##### \`url\`Required \`\`\`java public java.lang.String getUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URL of the identity provider. @@ -44149,11 +41068,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty; @@ -44163,21 +41082,21 @@ ProviderProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`keyArn\`](#softwareamazonawscdkservicesekscfnclusterproviderpropertypropertykeyarn) | \`java.lang.String\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| keyArn | java.lang.String | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`keyArn\`Optional +##### \`keyArn\`Optional \`\`\`java public java.lang.String getKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnCluster.ProviderProperty.KeyArn\`. @@ -44185,11 +41104,11 @@ public java.lang.String getKeyArn(); --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty; @@ -44200,22 +41119,22 @@ RemoteAccessProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ec2SshKey\`](#softwareamazonawscdkservicesekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`java.lang.String\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`sourceSecurityGroups\`](#softwareamazonawscdkservicesekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | java.util.List<\`java.lang.String\`> | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| ec2SshKey | java.lang.String | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| sourceSecurityGroups | java.util.List | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`ec2SshKey\`Required +##### \`ec2SshKey\`Required \`\`\`java public java.lang.String getEc2SshKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -44223,13 +41142,13 @@ public java.lang.String getEc2SshKey(); --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`java public java.util.List getSourceSecurityGroups(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -44237,11 +41156,11 @@ public java.util.List getSourceSecurityGroups(); --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty; @@ -44252,22 +41171,22 @@ ResourcesVpcConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`subnetIds\`](#softwareamazonawscdkservicesekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | java.util.List<\`java.lang.String\`> | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`securityGroupIds\`](#softwareamazonawscdkservicesekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | java.util.List<\`java.lang.String\`> | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| subnetIds | java.util.List | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| securityGroupIds | java.util.List | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`subnetIds\`Required +##### \`subnetIds\`Required \`\`\`java public java.util.List getSubnetIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -44275,13 +41194,13 @@ public java.util.List getSubnetIds(); --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`java public java.util.List getSecurityGroupIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -44289,11 +41208,11 @@ public java.util.List getSecurityGroupIds(); --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty; @@ -44305,23 +41224,23 @@ ScalingConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`desiredSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`maxSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`minSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertyminsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| desiredSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| maxSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| minSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -44329,13 +41248,13 @@ public java.lang.Number getDesiredSize(); --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -44343,13 +41262,13 @@ public java.lang.Number getMaxSize(); --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -44357,11 +41276,11 @@ public java.lang.Number getMinSize(); --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.Selector; @@ -44372,22 +41291,22 @@ Selector.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkserviceseksselectorpropertynamespace)* | \`java.lang.String\` | The Kubernetes namespace that the selector should match. | -| [\`labels\`](#softwareamazonawscdkserviceseksselectorpropertylabels) | java.util.Map | The Kubernetes labels that the selector should match. | +| namespace | java.lang.String | The Kubernetes namespace that the selector should match. | +| labels | java.util.Map | The Kubernetes labels that the selector should match. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Kubernetes namespace that the selector should match. @@ -44395,13 +41314,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -44410,11 +41329,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty; @@ -44427,22 +41346,22 @@ SelectorProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkservicesekscfnfargateprofileselectorpropertypropertynamespace)* | \`java.lang.String\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnfargateprofileselectorpropertypropertylabels) | [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| namespace | java.lang.String | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| labels | software.amazon.awscdk.IResolvable OR java.util.List | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -44450,13 +41369,13 @@ public java.lang.String getNamespace(); --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty) OR [\`software.amazon.awscdk.IResolvable\`](#software.amazon.awscdk.IResolvable)> +- *Type:* software.amazon.awscdk.IResolvable OR java.util.List \`CfnFargateProfile.SelectorProperty.Labels\`. @@ -44464,11 +41383,11 @@ public java.lang.Object getLabels(); --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccountOptions; @@ -44479,46 +41398,46 @@ ServiceAccountOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountoptionspropertyname) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountoptionspropertynamespace) | \`java.lang.String\` | The namespace of the service account. | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccountProps; @@ -44530,59 +41449,59 @@ ServiceAccountProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertyname) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertynamespace) | \`java.lang.String\` | The namespace of the service account. | -| [\`cluster\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions; @@ -44593,46 +41512,46 @@ ServiceLoadBalancerAddressOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceloadbalanceraddressoptionspropertynamespace) | \`java.lang.String\` | The namespace the service belongs to. | -| [\`timeout\`](#softwareamazonawscdkserviceseksserviceloadbalanceraddressoptionspropertytimeout) | [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) | Timeout for waiting on the load balancer address. | +| namespace | java.lang.String | The namespace the service belongs to. | +| timeout | software.amazon.awscdk.Duration | Timeout for waiting on the load balancer address. | --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the service belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Duration\`](#software.amazon.awscdk.Duration) +- *Type:* software.amazon.awscdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty; @@ -44644,23 +41563,23 @@ TaintProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`effect\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertyeffect) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`key\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertykey) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`value\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertyvalue) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Value\`. | +| effect | java.lang.String | \`CfnNodegroup.TaintProperty.Effect\`. | +| key | java.lang.String | \`CfnNodegroup.TaintProperty.Key\`. | +| value | java.lang.String | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`effect\`Optional +##### \`effect\`Optional \`\`\`java public java.lang.String getEffect(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Effect\`. @@ -44668,13 +41587,13 @@ public java.lang.String getEffect(); --- -##### \`key\`Optional +##### \`key\`Optional \`\`\`java public java.lang.String getKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Key\`. @@ -44682,13 +41601,13 @@ public java.lang.String getKey(); --- -##### \`value\`Optional +##### \`value\`Optional \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Value\`. @@ -44696,15 +41615,15 @@ public java.lang.String getValue(); --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`software.amazon.awscdk.services.ec2.IMachineImage\`](#software.amazon.awscdk.services.ec2.IMachineImage) +- *Implements:* software.amazon.awscdk.services.ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.EksOptimizedImage; @@ -44718,83 +41637,83 @@ EksOptimizedImage.Builder.create() | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpuArch\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparametercpuarch) | [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetesVersion\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparameterkubernetesversion) | \`java.lang.String\` | The Kubernetes version to use. | -| [\`nodeType\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparameternodetype) | [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpuArch | software.amazon.awscdk.services.eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetesVersion | java.lang.String | The Kubernetes version to use. | +| nodeType | software.amazon.awscdk.services.eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpuArch\`Optional +##### \`cpuArch\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) +- *Type:* software.amazon.awscdk.services.eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetesVersion\`Optional +##### \`kubernetesVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest version The Kubernetes version to use. --- -##### \`nodeType\`Optional +##### \`nodeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) +- *Type:* software.amazon.awscdk.services.eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`getImage\`](#softwareamazonawscdkservicesekseksoptimizedimagegetimage) | Return the correct image. | +| getImage | Return the correct image. | --- -##### \`getImage\` +##### \`getImage\` \`\`\`java public getImage(Construct scope) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`onlyFrom\`](#softwareamazonawscdkserviceseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| onlyFrom | Restrict public access to specific CIDR blocks. | --- -##### \`onlyFrom\` +##### \`onlyFrom\` \`\`\`java public onlyFrom(java.lang.String cidr) \`\`\` -###### \`cidr\`Required +###### \`cidr\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String CIDR blocks. @@ -44802,19 +41721,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PRIVATE\`](#softwareamazonawscdkserviceseksendpointaccesspropertyprivate)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`PUBLIC\`](#softwareamazonawscdkserviceseksendpointaccesspropertypublic)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PUBLIC_AND_PRIVATE\`](#softwareamazonawscdkserviceseksendpointaccesspropertypublicandprivate)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| PRIVATE | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| PUBLIC | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PUBLIC_AND_PRIVATE | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`PRIVATE\` +##### \`PRIVATE\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +\`\`\`java +public EndpointAccess getPrivate(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -44822,9 +41745,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`PUBLIC\` +##### \`PUBLIC\`Required + +\`\`\`java +public EndpointAccess getPublic(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -44832,9 +41759,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PUBLIC_AND_PRIVATE\` +##### \`PUBLIC_AND_PRIVATE\`Required + +\`\`\`java +public EndpointAccess getPublicAndPrivate(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -44842,20 +41773,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`of\`](#softwareamazonawscdkservicesekskubernetesversionof) | Custom cluster version. | +| of | Custom cluster version. | --- -##### \`of\` +##### \`of\` \`\`\`java import software.amazon.awscdk.services.eks.KubernetesVersion; @@ -44863,251 +41794,275 @@ import software.amazon.awscdk.services.eks.KubernetesVersion; KubernetesVersion.of(java.lang.String version) \`\`\` -###### \`version\`Required +###### \`version\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkservicesekskubernetesversionpropertyversion)* | \`java.lang.String\` | cluster version number. | +| version | java.lang.String | cluster version number. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V1_14\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv114)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V1_15\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv115)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V1_16\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv116)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V1_17\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv117)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V1_18\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv118)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V1_19\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv119)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.19. | +| V1_14 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.14. | +| V1_15 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.15. | +| V1_16 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.16. | +| V1_17 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.17. | +| V1_18 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.18. | +| V1_19 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V1_14\` +##### \`V1_14\`Required + +\`\`\`java +public KubernetesVersion getV114(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.14. --- -##### \`V1_15\` +##### \`V1_15\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +\`\`\`java +public KubernetesVersion getV115(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.15. --- -##### \`V1_16\` +##### \`V1_16\`Required + +\`\`\`java +public KubernetesVersion getV116(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.16. --- -##### \`V1_17\` +##### \`V1_17\`Required + +\`\`\`java +public KubernetesVersion getV117(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.17. --- -##### \`V1_18\` +##### \`V1_18\`Required + +\`\`\`java +public KubernetesVersion getV118(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.18. --- -##### \`V1_19\` +##### \`V1_19\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +\`\`\`java +public KubernetesVersion getV119(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`software.amazon.awscdk.IResource\`](#software.amazon.awscdk.IResource), [\`software.amazon.awscdk.services.ec2.IConnectable\`](#software.amazon.awscdk.services.ec2.IConnectable) +- *Extends:* software.amazon.awscdk.IResource, software.amazon.awscdk.services.ec2.IConnectable -- *Implemented By:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster), [\`software.amazon.awscdk.services.eks.FargateCluster\`](#software.amazon.awscdk.services.eks.FargateCluster), [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Implemented By:* software.amazon.awscdk.services.eks.Cluster, software.amazon.awscdk.services.eks.FargateCluster, software.amazon.awscdk.services.eks.ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addCdk8sChart\`](#softwareamazonawscdkserviceseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addHelmChart\`](#softwareamazonawscdkserviceseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#softwareamazonawscdkserviceseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addServiceAccount\`](#softwareamazonawscdkserviceseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`java public addCdk8sChart(java.lang.String id, Construct chart) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the cdk8s chart. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`java public addHelmChart(java.lang.String id, HelmChartOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.HelmChartOptions\`](#software.amazon.awscdk.services.eks.HelmChartOptions) +- *Type:* software.amazon.awscdk.services.eks.HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`java public addManifest(java.lang.String id, java.util.Map manifest) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map a list of Kubernetes resource specifications. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`java public addServiceAccount(java.lang.String id) public addServiceAccount(java.lang.String id, ServiceAccountOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of service account. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceAccountOptions\`](#software.amazon.awscdk.services.eks.ServiceAccountOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceAccountOptions service account options. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkserviceseksiclusterpropertynode)* | [\`software.constructs.Node\`](#software.constructs.Node) | The tree node. | -| [\`env\`](#softwareamazonawscdkserviceseksiclusterpropertyenv)* | [\`software.amazon.awscdk.ResourceEnvironment\`](#software.amazon.awscdk.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkserviceseksiclusterpropertystack)* | [\`software.amazon.awscdk.Stack\`](#software.amazon.awscdk.Stack) | The stack in which this resource is defined. | -| [\`connections\`](#softwareamazonawscdkserviceseksiclusterpropertyconnections)* | [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) | *No description.* | -| [\`clusterArn\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterarn)* | \`java.lang.String\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksiclusterpropertyclustercertificateauthoritydata)* | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterendpoint)* | \`java.lang.String\` | The API Server endpoint URL. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksiclusterpropertyclustername)* | \`java.lang.String\` | The physical name of the Cluster. | -| [\`clusterSecurityGroup\`](#softwareamazonawscdkserviceseksiclusterpropertyclustersecuritygroup)* | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksiclusterpropertyclustersecuritygroupid)* | \`java.lang.String\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksiclusterpropertyopenidconnectprovider)* | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`prune\`](#softwareamazonawscdkserviceseksiclusterpropertyprune)* | \`java.lang.Boolean\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`vpc\`](#softwareamazonawscdkserviceseksiclusterpropertyvpc)* | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlenvironment) | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksiclusterpropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlmemory) | [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlprivatesubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlsecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| node | software.constructs.Node | The tree node. | +| env | software.amazon.awscdk.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.Stack | The stack in which this resource is defined. | +| connections | software.amazon.awscdk.services.ec2.Connections | *No description.* | +| clusterArn | java.lang.String | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The API Server endpoint URL. | +| clusterName | java.lang.String | The physical name of the Cluster. | +| clusterSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | java.lang.String | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources can be automatically pruned. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | +| kubectlEnvironment | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| kubectlMemory | software.amazon.awscdk.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnets | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | software.amazon.awscdk.services.iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`java public Node getNode(); \`\`\` -- *Type:* [\`software.constructs.Node\`](#software.constructs.Node) +- *Type:* software.constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.ResourceEnvironment\`](#software.amazon.awscdk.ResourceEnvironment) +- *Type:* software.amazon.awscdk.ResourceEnvironment The environment this resource belongs to. @@ -45115,131 +42070,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Stack\`](#software.amazon.awscdk.Stack) +- *Type:* software.amazon.awscdk.Stack The stack in which this resource is defined. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`java public Connections getConnections(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) +- *Type:* software.amazon.awscdk.services.ec2.Connections --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`java public java.lang.String getClusterArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The API Server endpoint URL. --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The physical name of the Cluster. --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`java public ISecurityGroup getClusterSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean Indicates whether Kubernetes resources can be automatically pruned. @@ -45247,37 +42202,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc The VPC in which this Cluster was created. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -45285,25 +42240,25 @@ If not defined, a default layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Size\`](#software.amazon.awscdk.Size) +- *Type:* software.amazon.awscdk.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> +- *Type:* java.util.List Subnets to host the \`kubectl\` compute resources. @@ -45311,13 +42266,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`java public IRole getKubectlRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -45325,13 +42280,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`java public ISecurityGroup getKubectlSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -45339,45 +42294,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`software.amazon.awscdk.IResource\`](#software.amazon.awscdk.IResource) +- *Extends:* software.amazon.awscdk.IResource -- *Implemented By:* [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup), [\`software.amazon.awscdk.services.eks.INodegroup\`](#software.amazon.awscdk.services.eks.INodegroup) +- *Implemented By:* software.amazon.awscdk.services.eks.Nodegroup, software.amazon.awscdk.services.eks.INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkserviceseksinodegrouppropertynode)* | [\`software.constructs.Node\`](#software.constructs.Node) | The tree node. | -| [\`env\`](#softwareamazonawscdkserviceseksinodegrouppropertyenv)* | [\`software.amazon.awscdk.ResourceEnvironment\`](#software.amazon.awscdk.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkserviceseksinodegrouppropertystack)* | [\`software.amazon.awscdk.Stack\`](#software.amazon.awscdk.Stack) | The stack in which this resource is defined. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksinodegrouppropertynodegroupname)* | \`java.lang.String\` | Name of the nodegroup. | +| node | software.constructs.Node | The tree node. | +| env | software.amazon.awscdk.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.Stack | The stack in which this resource is defined. | +| nodegroupName | java.lang.String | Name of the nodegroup. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`java public Node getNode(); \`\`\` -- *Type:* [\`software.constructs.Node\`](#software.constructs.Node) +- *Type:* software.constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.ResourceEnvironment\`](#software.amazon.awscdk.ResourceEnvironment) +- *Type:* software.amazon.awscdk.ResourceEnvironment The environment this resource belongs to. @@ -45385,164 +42340,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.Stack\`](#software.amazon.awscdk.Stack) +- *Type:* software.amazon.awscdk.Stack The stack in which this resource is defined. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#softwareamazonawscdkservicesekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#softwareamazonawscdkservicesekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#softwareamazonawscdkservicesekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#softwareamazonawscdkservicesekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#softwareamazonawscdkservicesekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#softwareamazonawscdkservicesekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#softwareamazonawscdkserviceseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#softwareamazonawscdkserviceseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#softwareamazonawscdkserviceseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#softwareamazonawscdkserviceseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -45550,87 +42505,87 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#softwareamazonawscdkserviceseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#softwareamazonawscdkserviceseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#softwareamazonawscdkserviceseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` Inferentia instances. --- -### PatchType +### PatchType | **Name** | **Description** | | --- | --- | -| [\`JSON\`](#softwareamazonawscdkservicesekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#softwareamazonawscdkservicesekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#softwareamazonawscdkservicesekspatchtypestrategic) | Strategic merge patch. | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | --- Values for \`kubectl patch\` --type argument. -#### \`JSON\` +#### \`JSON\` JSON Patch, RFC 6902. --- -#### \`MERGE\` +#### \`MERGE\` JSON Merge patch. --- -#### \`STRATEGIC\` +#### \`STRATEGIC\` Strategic merge patch. @@ -46853,15 +43808,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.AwsAuth; @@ -46873,27 +43828,27 @@ AwsAuth.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksawsauthparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksawsauthparameterid)* | \`java.lang.String\` | *No description.* | -| [\`cluster\`](#softwareamazonawscdkserviceseksawsauthpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply this configuration to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply this configuration to. @@ -46901,93 +43856,93 @@ The EKS cluster to apply this configuration to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAccount\`](#softwareamazonawscdkserviceseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`addMastersRole\`](#softwareamazonawscdkserviceseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`addRoleMapping\`](#softwareamazonawscdkserviceseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`addUserMapping\`](#softwareamazonawscdkserviceseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| addAccount | Additional AWS account to add to the aws-auth configmap. | +| addMastersRole | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| addRoleMapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| addUserMapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`addAccount\` +##### \`addAccount\` \`\`\`java public addAccount(java.lang.String accountId) \`\`\` -###### \`accountId\`Required +###### \`accountId\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String account number. --- -##### \`addMastersRole\` +##### \`addMastersRole\` \`\`\`java public addMastersRole(IRole role) public addMastersRole(IRole role, java.lang.String username) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The IAM role to add. --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Optional user (defaults to the role ARN). --- -##### \`addRoleMapping\` +##### \`addRoleMapping\` \`\`\`java public addRoleMapping(IRole role, AwsAuthMapping mapping) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The IAM role to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuthMapping\`](#software.amazon.awscdk.services.eks.AwsAuthMapping) +- *Type:* software.amazon.awscdk.services.eks.AwsAuthMapping Mapping to k8s user name and groups. --- -##### \`addUserMapping\` +##### \`addUserMapping\` \`\`\`java public addUserMapping(IUser user, AwsAuthMapping mapping) \`\`\` -###### \`user\`Required +###### \`user\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IUser\`](#software.amazon.awscdk.services.iam.IUser) +- *Type:* software.amazon.awscdk.services.iam.IUser The IAM user to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuthMapping\`](#software.amazon.awscdk.services.eks.AwsAuthMapping) +- *Type:* software.amazon.awscdk.services.eks.AwsAuthMapping Mapping to k8s user name and groups. @@ -46996,15 +43951,15 @@ Mapping to k8s user name and groups. -### CfnAddon +### CfnAddon -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnAddon; @@ -47021,36 +43976,36 @@ CfnAddon.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnaddonparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnaddonparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropsparameteraddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropsparameteraddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropsparameterserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::EKS::Addon.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | java.util.List | \`AWS::EKS::Addon.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`addonName\`Required +##### \`addonName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -47058,9 +44013,9 @@ scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -47068,9 +44023,9 @@ scoped id of the resource. --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -47078,9 +44033,9 @@ scoped id of the resource. --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -47088,9 +44043,9 @@ scoped id of the resource. --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -47098,9 +44053,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::Addon.Tags\`. @@ -47108,60 +44063,60 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnaddonpropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropertyaddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropertyaddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropertyresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropertyserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::EKS::Addon.Tags\`. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::EKS::Addon.Tags\`. @@ -47169,13 +44124,13 @@ public TagManager getTags(); --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`java public java.lang.String getAddonName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -47183,13 +44138,13 @@ public java.lang.String getAddonName(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -47197,13 +44152,13 @@ public java.lang.String getClusterName(); --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`java public java.lang.String getAddonVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -47211,13 +44166,13 @@ public java.lang.String getAddonVersion(); --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`java public java.lang.String getResolveConflicts(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -47225,13 +44180,13 @@ public java.lang.String getResolveConflicts(); --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`java public java.lang.String getServiceAccountRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -47239,31 +44194,35 @@ public java.lang.String getServiceAccountRoleArn(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnaddonpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster; @@ -47284,36 +44243,36 @@ CfnCluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnclusterparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnclusterparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterencryptionconfig) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterkubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropsparametername) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropsparameterversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -47321,9 +44280,9 @@ scoped id of the resource. --- -##### \`roleArn\`Required +##### \`roleArn\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -47331,9 +44290,9 @@ scoped id of the resource. --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -47341,9 +44300,9 @@ scoped id of the resource. --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -47351,9 +44310,9 @@ scoped id of the resource. --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -47361,9 +44320,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -47371,115 +44330,115 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrCertificateAuthorityData\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrcertificateauthoritydata)* | \`java.lang.String\` | *No description.* | -| [\`attrClusterSecurityGroupId\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrclustersecuritygroupid)* | \`java.lang.String\` | *No description.* | -| [\`attrEncryptionConfigKeyArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`java.lang.String\` | *No description.* | -| [\`attrEndpoint\`](#softwareamazonawscdkservicesekscfnclusterpropertyattrendpoint)* | \`java.lang.String\` | *No description.* | -| [\`attrOpenIdConnectIssuerUrl\`](#softwareamazonawscdkservicesekscfnclusterpropertyattropenidconnectissuerurl)* | \`java.lang.String\` | *No description.* | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertyresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropertyrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertyencryptionconfig) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropertykubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropertyname) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropertyversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| attrArn | java.lang.String | *No description.* | +| attrCertificateAuthorityData | java.lang.String | *No description.* | +| attrClusterSecurityGroupId | java.lang.String | *No description.* | +| attrEncryptionConfigKeyArn | java.lang.String | *No description.* | +| attrEndpoint | java.lang.String | *No description.* | +| attrOpenIdConnectIssuerUrl | java.lang.String | *No description.* | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrCertificateAuthorityData\`Required +##### \`attrCertificateAuthorityData\`Required \`\`\`java public java.lang.String getAttrCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrClusterSecurityGroupId\`Required +##### \`attrClusterSecurityGroupId\`Required \`\`\`java public java.lang.String getAttrClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrEncryptionConfigKeyArn\`Required +##### \`attrEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getAttrEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrEndpoint\`Required +##### \`attrEndpoint\`Required \`\`\`java public java.lang.String getAttrEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrOpenIdConnectIssuerUrl\`Required +##### \`attrOpenIdConnectIssuerUrl\`Required \`\`\`java public java.lang.String getAttrOpenIdConnectIssuerUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`java public java.lang.Object getResourcesVpcConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -47487,13 +44446,13 @@ public java.lang.Object getResourcesVpcConfig(); --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`java public java.lang.String getRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -47501,13 +44460,13 @@ public java.lang.String getRoleArn(); --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`java public java.lang.Object getEncryptionConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -47515,13 +44474,13 @@ public java.lang.Object getEncryptionConfig(); --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`java public java.lang.Object getKubernetesNetworkConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -47529,13 +44488,13 @@ public java.lang.Object getKubernetesNetworkConfig(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -47543,13 +44502,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -47557,31 +44516,35 @@ public java.lang.String getVersion(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnclusterpropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile; @@ -47600,36 +44563,36 @@ CfnFargateProfile.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnfargateprofileparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnfargateprofileparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterpodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterselectors)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparameterfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparametersubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::EKS::FargateProfile.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | java.util.List | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -47637,9 +44600,9 @@ scoped id of the resource. --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -47647,9 +44610,9 @@ scoped id of the resource. --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -47657,9 +44620,9 @@ scoped id of the resource. --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -47667,9 +44630,9 @@ scoped id of the resource. --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -47677,9 +44640,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Tags\`. @@ -47687,60 +44650,60 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertypodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyselectors)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertyfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertysubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | +| attrArn | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -47748,13 +44711,13 @@ public TagManager getTags(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -47762,13 +44725,13 @@ public java.lang.String getClusterName(); --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`java public java.lang.String getPodExecutionRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -47776,13 +44739,13 @@ public java.lang.String getPodExecutionRoleArn(); --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.lang.Object getSelectors(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -47790,13 +44753,13 @@ public java.lang.Object getSelectors(); --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -47804,13 +44767,13 @@ public java.lang.String getFargateProfileName(); --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -47818,31 +44781,35 @@ public java.util.List getSubnets(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnfargateprofilepropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`software.amazon.awscdk.core.IInspectable\`](#software.amazon.awscdk.core.IInspectable) +- *Implements:* software.amazon.awscdk.core.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup; @@ -47876,47 +44843,47 @@ CfnNodegroup.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekscfnnodegroupparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesekscfnnodegroupparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameternoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametersubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameteramitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametercapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterdisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterlabels) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterlaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameternodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametertags) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparametertaints) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropsparameterversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | java.lang.Object | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -##### \`clusterName\`Required +##### \`clusterName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -47924,9 +44891,9 @@ scoped id of the resource. --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -47934,9 +44901,9 @@ scoped id of the resource. --- -##### \`subnets\`Required +##### \`subnets\`Required -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -47944,9 +44911,9 @@ scoped id of the resource. --- -##### \`amiType\`Optional +##### \`amiType\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -47954,9 +44921,9 @@ scoped id of the resource. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -47964,9 +44931,9 @@ scoped id of the resource. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -47974,9 +44941,9 @@ scoped id of the resource. --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -47984,9 +44951,9 @@ scoped id of the resource. --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -47994,9 +44961,9 @@ scoped id of the resource. --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -48004,9 +44971,9 @@ scoped id of the resource. --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -48014,9 +44981,9 @@ scoped id of the resource. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -48024,9 +44991,9 @@ scoped id of the resource. --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -48034,9 +45001,9 @@ scoped id of the resource. --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -48044,9 +45011,9 @@ scoped id of the resource. --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -48054,9 +45021,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Tags\`. @@ -48064,9 +45031,9 @@ scoped id of the resource. --- -##### \`taints\`Optional +##### \`taints\`Optional -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -48074,9 +45041,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -48084,93 +45051,93 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#softwareamazonawscdkservicesekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrarn)* | \`java.lang.String\` | *No description.* | -| [\`attrClusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrclustername)* | \`java.lang.String\` | *No description.* | -| [\`attrNodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyattrnodegroupname)* | \`java.lang.String\` | *No description.* | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropertylabels)* | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropertynoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropertysubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyamitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropertycapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropertydisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropertylaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropertynodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropertytaints) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropertyversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| attrArn | java.lang.String | *No description.* | +| attrClusterName | java.lang.String | *No description.* | +| attrNodegroupName | java.lang.String | *No description.* | +| tags | software.amazon.awscdk.core.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| taints | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`java public java.lang.String getAttrArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrClusterName\`Required +##### \`attrClusterName\`Required \`\`\`java public java.lang.String getAttrClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`attrNodegroupName\`Required +##### \`attrNodegroupName\`Required \`\`\`java public java.lang.String getAttrNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -48178,13 +45145,13 @@ public TagManager getTags(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -48192,13 +45159,13 @@ public java.lang.String getClusterName(); --- -##### \`labels\`Required +##### \`labels\`Required \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -48206,13 +45173,13 @@ public java.lang.Object getLabels(); --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`java public java.lang.String getNodeRole(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -48220,13 +45187,13 @@ public java.lang.String getNodeRole(); --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -48234,13 +45201,13 @@ public java.util.List getSubnets(); --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public java.lang.String getAmiType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -48248,13 +45215,13 @@ public java.lang.String getAmiType(); --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public java.lang.String getCapacityType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -48262,13 +45229,13 @@ public java.lang.String getCapacityType(); --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -48276,13 +45243,13 @@ public java.lang.Number getDiskSize(); --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`java public java.lang.Object getForceUpdateEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -48290,13 +45257,13 @@ public java.lang.Object getForceUpdateEnabled(); --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -48304,13 +45271,13 @@ public java.util.List getInstanceTypes(); --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`java public java.lang.Object getLaunchTemplate(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -48318,13 +45285,13 @@ public java.lang.Object getLaunchTemplate(); --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -48332,13 +45299,13 @@ public java.lang.String getNodegroupName(); --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -48346,13 +45313,13 @@ public java.lang.String getReleaseVersion(); --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public java.lang.Object getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -48360,13 +45327,13 @@ public java.lang.Object getRemoteAccess(); --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`java public java.lang.Object getScalingConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -48374,13 +45341,13 @@ public java.lang.Object getScalingConfig(); --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`java public java.lang.Object getTaints(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -48388,13 +45355,13 @@ public java.lang.Object getTaints(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -48402,31 +45369,35 @@ public java.lang.String getVersion(); --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#softwareamazonawscdkservicesekscfnnodegrouppropertycfnresourcetypename)* | \`java.lang.String\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | java.lang.String | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`java.lang.String\` +\`\`\`java +public java.lang.String getCfnResourceTypeName(); +\`\`\` + +- *Type:* java.lang.String The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Implements:* software.amazon.awscdk.services.eks.ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.Cluster; @@ -48459,78 +45430,78 @@ Cluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksclusterparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`id\`](#softwareamazonawscdkserviceseksclusterparameterid)* | \`java.lang.String\` | the id of the Construct to create. | -| [\`version\`](#softwareamazonawscdkserviceseksclusterpropsparameterversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropsparameterclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropsparameterrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusterpropsparametersecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusterpropsparametervpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusterpropsparameterclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusterpropsparametercorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusterpropsparameterendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropsparameterkubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusterpropsparametermastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusterpropsparameteroutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusterpropsparameterplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropsparameterprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusterpropsparametersecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacity) | \`java.lang.Number\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`defaultCapacityInstance\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacityinstance) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`defaultCapacityType\`](#softwareamazonawscdkserviceseksclusterpropsparameterdefaultcapacitytype) | [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) | The default capacity type for the cluster. | +| scope | software.constructs.Construct | a Construct, most likely a cdk.Stack created. | +| id | java.lang.String | the id of the Construct to create. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultCapacity | java.lang.Number | Number of instances to allocate as an initial capacity for this cluster. | +| defaultCapacityInstance | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for the default capacity. | +| defaultCapacityType | software.amazon.awscdk.services.eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id of the Construct to create. --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -48539,36 +45510,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -48577,38 +45548,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -48617,60 +45588,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -48679,18 +45650,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -48699,9 +45670,9 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`defaultCapacityInstance\`Optional +##### \`defaultCapacityInstance\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -48710,233 +45681,233 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`defaultCapacityType\`Optional +##### \`defaultCapacityType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) +- *Type:* software.amazon.awscdk.services.eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAutoScalingGroupCapacity\`](#softwareamazonawscdkserviceseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`addCdk8sChart\`](#softwareamazonawscdkserviceseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addFargateProfile\`](#softwareamazonawscdkserviceseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`addHelmChart\`](#softwareamazonawscdkserviceseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#softwareamazonawscdkserviceseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addNodegroupCapacity\`](#softwareamazonawscdkserviceseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`addServiceAccount\`](#softwareamazonawscdkserviceseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`connectAutoScalingGroupCapacity\`](#softwareamazonawscdkserviceseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`getServiceLoadBalancerAddress\`](#softwareamazonawscdkserviceseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| addAutoScalingGroupCapacity | Add nodes to this EKS cluster. | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addFargateProfile | Adds a Fargate profile to this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addNodegroupCapacity | Add managed nodegroup to this Amazon EKS cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | +| connectAutoScalingGroupCapacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| getServiceLoadBalancerAddress | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`addAutoScalingGroupCapacity\` +##### \`addAutoScalingGroupCapacity\` \`\`\`java public addAutoScalingGroupCapacity(java.lang.String id, AutoScalingGroupCapacityOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions\`](#software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions) +- *Type:* software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`java public addCdk8sChart(java.lang.String id, Construct chart) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the cdk8s chart. --- -##### \`addFargateProfile\` +##### \`addFargateProfile\` \`\`\`java public addFargateProfile(java.lang.String id, FargateProfileOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id of this profile. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions profile options. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`java public addHelmChart(java.lang.String id, HelmChartOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.HelmChartOptions\`](#software.amazon.awscdk.services.eks.HelmChartOptions) +- *Type:* software.amazon.awscdk.services.eks.HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`java public addManifest(java.lang.String id, java.util.Map manifest) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map a list of Kubernetes resource specifications. --- -##### \`addNodegroupCapacity\` +##### \`addNodegroupCapacity\` \`\`\`java public addNodegroupCapacity(java.lang.String id) public addNodegroupCapacity(java.lang.String id, NodegroupOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ID of the nodegroup. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupOptions\`](#software.amazon.awscdk.services.eks.NodegroupOptions) +- *Type:* software.amazon.awscdk.services.eks.NodegroupOptions options for creating a new nodegroup. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`java public addServiceAccount(java.lang.String id) public addServiceAccount(java.lang.String id, ServiceAccountOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceAccountOptions\`](#software.amazon.awscdk.services.eks.ServiceAccountOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceAccountOptions --- -##### \`connectAutoScalingGroupCapacity\` +##### \`connectAutoScalingGroupCapacity\` \`\`\`java public connectAutoScalingGroupCapacity(AutoScalingGroup autoScalingGroup, AutoScalingGroupOptions options) \`\`\` -###### \`autoScalingGroup\`Required +###### \`autoScalingGroup\`Required -- *Type:* [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) +- *Type:* software.amazon.awscdk.services.autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.AutoScalingGroupOptions\`](#software.amazon.awscdk.services.eks.AutoScalingGroupOptions) +- *Type:* software.amazon.awscdk.services.eks.AutoScalingGroupOptions options for adding auto scaling groups, like customizing the bootstrap script. --- -##### \`getServiceLoadBalancerAddress\` +##### \`getServiceLoadBalancerAddress\` \`\`\`java public getServiceLoadBalancerAddress(java.lang.String serviceName) public getServiceLoadBalancerAddress(java.lang.String serviceName, ServiceLoadBalancerAddressOptions options) \`\`\` -###### \`serviceName\`Required +###### \`serviceName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the service. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions\`](#software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions Additional operation options. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromClusterAttributes\`](#softwareamazonawscdkserviceseksclusterfromclusterattributes) | Import an existing cluster. | +| fromClusterAttributes | Import an existing cluster. | --- -##### \`fromClusterAttributes\` +##### \`fromClusterAttributes\` \`\`\`java import software.amazon.awscdk.services.eks.Cluster; @@ -48944,68 +45915,68 @@ import software.amazon.awscdk.services.eks.Cluster; Cluster.fromClusterAttributes(Construct scope, java.lang.String id, ClusterAttributes attrs) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the construct scope, in most cases 'this'. --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String the id or name to import as. --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ClusterAttributes\`](#software.amazon.awscdk.services.eks.ClusterAttributes) +- *Type:* software.amazon.awscdk.services.eks.ClusterAttributes the cluster properties to use for importing information. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`adminRole\`](#softwareamazonawscdkserviceseksclusterpropertyadminrole)* | [\`software.amazon.awscdk.services.iam.Role\`](#software.amazon.awscdk.services.iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`awsAuth\`](#softwareamazonawscdkserviceseksclusterpropertyawsauth)* | [\`software.amazon.awscdk.services.eks.AwsAuth\`](#software.amazon.awscdk.services.eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`clusterArn\`](#softwareamazonawscdkserviceseksclusterpropertyclusterarn)* | \`java.lang.String\` | The AWS generated ARN for the Cluster resource. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksclusterpropertyclustercertificateauthoritydata)* | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksclusterpropertyclusterencryptionconfigkeyarn)* | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksclusterpropertyclusterendpoint)* | \`java.lang.String\` | The endpoint URL for the Cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropertyclustername)* | \`java.lang.String\` | The Name of the created EKS Cluster. | -| [\`clusterOpenIdConnectIssuer\`](#softwareamazonawscdkserviceseksclusterpropertyclusteropenidconnectissuer)* | \`java.lang.String\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`clusterOpenIdConnectIssuerUrl\`](#softwareamazonawscdkserviceseksclusterpropertyclusteropenidconnectissuerurl)* | \`java.lang.String\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`clusterSecurityGroup\`](#softwareamazonawscdkserviceseksclusterpropertyclustersecuritygroup)* | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterpropertyclustersecuritygroupid)* | \`java.lang.String\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`connections\`](#softwareamazonawscdkserviceseksclusterpropertyconnections)* | [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksclusterpropertyopenidconnectprovider)* | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropertyprune)* | \`java.lang.Boolean\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropertyvpc)* | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropertydefaultcapacity) | [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`defaultNodegroup\`](#softwareamazonawscdkserviceseksclusterpropertydefaultnodegroup) | [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropertykubectlenvironment) | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#softwareamazonawscdkserviceseksclusterpropertykubectlprivatesubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#softwareamazonawscdkserviceseksclusterpropertykubectlrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#softwareamazonawscdkserviceseksclusterpropertykubectlsecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| adminRole | software.amazon.awscdk.services.iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| awsAuth | software.amazon.awscdk.services.eks.AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| clusterArn | java.lang.String | The AWS generated ARN for the Cluster resource. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The endpoint URL for the Cluster. | +| clusterName | java.lang.String | The Name of the created EKS Cluster. | +| clusterOpenIdConnectIssuer | java.lang.String | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| clusterOpenIdConnectIssuerUrl | java.lang.String | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| clusterSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | java.lang.String | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| connections | software.amazon.awscdk.services.ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| prune | java.lang.Boolean | Determines if Kubernetes resources can be pruned automatically. | +| role | software.amazon.awscdk.services.iam.IRole | IAM role assumed by the EKS Control Plane. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | +| defaultCapacity | software.amazon.awscdk.services.autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| defaultNodegroup | software.amazon.awscdk.services.eks.Nodegroup | The node group that hosts the default capacity for this cluster. | +| kubectlEnvironment | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| kubectlPrivateSubnets | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | software.amazon.awscdk.services.iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`adminRole\`Required +##### \`adminRole\`Required \`\`\`java public Role getAdminRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.Role\`](#software.amazon.awscdk.services.iam.Role) +- *Type:* software.amazon.awscdk.services.iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -49013,61 +45984,61 @@ This role also has \`systems:master\` permissions. --- -##### \`awsAuth\`Required +##### \`awsAuth\`Required \`\`\`java public AwsAuth getAwsAuth(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.AwsAuth\`](#software.amazon.awscdk.services.eks.AwsAuth) +- *Type:* software.amazon.awscdk.services.eks.AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`java public java.lang.String getClusterArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The AWS generated ARN for the Cluster resource. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The endpoint URL for the Cluster. @@ -49075,25 +46046,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Name of the created EKS Cluster. --- -##### \`clusterOpenIdConnectIssuer\`Required +##### \`clusterOpenIdConnectIssuer\`Required \`\`\`java public java.lang.String getClusterOpenIdConnectIssuer(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -49101,13 +46072,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterOpenIdConnectIssuerUrl\`Required +##### \`clusterOpenIdConnectIssuerUrl\`Required \`\`\`java public java.lang.String getClusterOpenIdConnectIssuerUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -49115,49 +46086,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`java public ISecurityGroup getClusterSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`java public Connections getConnections(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) +- *Type:* software.amazon.awscdk.services.ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -49165,49 +46136,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean Determines if Kubernetes resources can be pruned automatically. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc The VPC in which this Cluster was created. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`java public AutoScalingGroup getDefaultCapacity(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.AutoScalingGroup\`](#software.amazon.awscdk.services.autoscaling.AutoScalingGroup) +- *Type:* software.amazon.awscdk.services.autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -49215,13 +46186,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`defaultNodegroup\`Optional +##### \`defaultNodegroup\`Optional \`\`\`java public Nodegroup getDefaultNodegroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup) +- *Type:* software.amazon.awscdk.services.eks.Nodegroup The node group that hosts the default capacity for this cluster. @@ -49229,25 +46200,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -49255,38 +46226,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> +- *Type:* java.util.List - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`java public IRole getKubectlRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -49294,13 +46265,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`java public ISecurityGroup getKubectlSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -49308,13 +46279,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.FargateCluster; @@ -49345,72 +46316,72 @@ FargateCluster.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksfargateclusterparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksfargateclusterparameterid)* | \`java.lang.String\` | *No description.* | -| [\`version\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametersecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametervpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametercorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterkubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametermastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameteroutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksfargateclusterpropsparametersecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultProfile\`](#softwareamazonawscdkserviceseksfargateclusterpropsparameterdefaultprofile) | [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultProfile | software.amazon.awscdk.services.eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -49419,36 +46390,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -49457,38 +46428,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -49497,60 +46468,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -49559,18 +46530,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultProfile\`Optional +##### \`defaultProfile\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. @@ -49581,15 +46552,15 @@ Fargate Profile to create along with the cluster. -### FargateProfile +### FargateProfile -- *Implements:* [\`software.amazon.awscdk.core.ITaggable\`](#software.amazon.awscdk.core.ITaggable) +- *Implements:* software.amazon.awscdk.core.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.FargateProfile; @@ -49606,32 +46577,32 @@ FargateProfile.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksfargateprofileparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksfargateprofileparameterid)* | \`java.lang.String\` | *No description.* | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropsparameterpodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametersubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametervpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#softwareamazonawscdkserviceseksfargateprofilepropsparametercluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -49639,31 +46610,31 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -49672,9 +46643,9 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -49683,9 +46654,9 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -49695,48 +46666,48 @@ The EKS cluster to apply the Fargate profile to. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`fargateProfileArn\`](#softwareamazonawscdkserviceseksfargateprofilepropertyfargateprofilearn)* | \`java.lang.String\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropertyfargateprofilename)* | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropertypodexecutionrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`tags\`](#softwareamazonawscdkserviceseksfargateprofilepropertytags)* | [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) | Resource tags. | +| fargateProfileArn | java.lang.String | The full Amazon Resource Name (ARN) of the Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| tags | software.amazon.awscdk.core.TagManager | Resource tags. | --- -##### \`fargateProfileArn\`Required +##### \`fargateProfileArn\`Required \`\`\`java public java.lang.String getFargateProfileArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`fargateProfileName\`Required +##### \`fargateProfileName\`Required \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the Fargate profile. --- -##### \`podExecutionRole\`Required +##### \`podExecutionRole\`Required \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -49744,26 +46715,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`java public TagManager getTags(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.TagManager\`](#software.amazon.awscdk.core.TagManager) +- *Type:* software.amazon.awscdk.core.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.HelmChart; @@ -49784,71 +46755,71 @@ HelmChart.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekshelmchartparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekshelmchartparameterid)* | \`java.lang.String\` | *No description.* | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartpropsparameterchart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartpropsparametercreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartpropsparameternamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartpropsparameterrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartpropsparameterrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartpropsparametertimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartpropsparametervalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartpropsparameterversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartpropsparameterwait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#softwareamazonawscdkservicesekshelmchartpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this configuration to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.core.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`chart\`Required +##### \`chart\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -49857,9 +46828,9 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -49868,36 +46839,36 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this configuration to. @@ -49908,29 +46879,33 @@ The EKS cluster to apply this configuration to. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekshelmchartpropertyresourcetype)* | \`java.lang.String\` | The CloudFormation resource type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation resource type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifest; @@ -49946,53 +46921,53 @@ KubernetesManifest.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetesmanifestparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetesmanifestparameterid)* | \`java.lang.String\` | *No description.* | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameterprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameterskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparametermanifest)* | java.util.List> | The manifest to apply. | -| [\`overwrite\`](#softwareamazonawscdkservicesekskubernetesmanifestpropsparameteroverwrite) | \`java.lang.Boolean\` | Overwrite any existing resources. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this manifest to. | +| manifest | java.util.List> | The manifest to apply. | +| overwrite | java.lang.Boolean | Overwrite any existing resources. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this manifest to. @@ -50000,9 +46975,9 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required -- *Type:* java.util.List> +- *Type:* java.util.List> The manifest to apply. @@ -50010,9 +46985,9 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Overwrite any existing resources. @@ -50024,29 +46999,33 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekskubernetesmanifestpropertyresourcetype)* | \`java.lang.String\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesObjectValue; @@ -50063,32 +47042,32 @@ KubernetesObjectValue.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetesobjectvalueparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetesobjectvalueparameterid)* | \`java.lang.String\` | *No description.* | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`jsonPath\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterjsonpath)* | \`java.lang.String\` | JSONPath to the specific value. | -| [\`objectName\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjectname)* | \`java.lang.String\` | The name of the object to query. | -| [\`objectType\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjecttype)* | \`java.lang.String\` | The object type to query. | -| [\`objectNamespace\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparameterobjectnamespace) | \`java.lang.String\` | The namespace the object belongs to. | -| [\`timeout\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropsparametertimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Timeout for waiting on a value. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to fetch attributes from. | +| jsonPath | java.lang.String | JSONPath to the specific value. | +| objectName | java.lang.String | The name of the object to query. | +| objectType | java.lang.String | The object type to query. | +| objectNamespace | java.lang.String | The namespace the object belongs to. | +| timeout | software.amazon.awscdk.core.Duration | Timeout for waiting on a value. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to fetch attributes from. @@ -50096,27 +47075,27 @@ The EKS cluster to fetch attributes from. --- -##### \`jsonPath\`Required +##### \`jsonPath\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`objectName\`Required +##### \`objectName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the object to query. --- -##### \`objectType\`Required +##### \`objectType\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The object type to query. @@ -50124,18 +47103,18 @@ The object type to query. --- -##### \`objectNamespace\`Optional +##### \`objectNamespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. @@ -50144,49 +47123,53 @@ Timeout for waiting on a value. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`value\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropertyvalue)* | \`java.lang.String\` | The value as a string token. | +| value | java.lang.String | The value as a string token. | --- -##### \`value\`Required +##### \`value\`Required \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropertyresourcetype)* | \`java.lang.String\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | java.lang.String | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`java +public java.lang.String getResourceType(); +\`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.KubernetesPatch; @@ -50203,40 +47186,40 @@ KubernetesPatch.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesekskubernetespatchparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkservicesekskubernetespatchparameterid)* | \`java.lang.String\` | *No description.* | -| [\`applyPatch\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterapplypatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetespatchpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | -| [\`resourceName\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterresourcename)* | \`java.lang.String\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restorePatch\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterrestorepatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patchType\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterpatchtype) | [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resourceNamespace\`](#softwareamazonawscdkservicesekskubernetespatchpropsparameterresourcenamespace) | \`java.lang.String\` | The kubernetes API namespace. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| applyPatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | +| resourceName | java.lang.String | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restorePatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patchType | software.amazon.awscdk.services.eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| resourceNamespace | java.lang.String | The kubernetes API namespace. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`applyPatch\`Required +##### \`applyPatch\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. @@ -50244,25 +47227,25 @@ The cluster to apply the patch to. --- -##### \`resourceName\`Required +##### \`resourceName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restorePatch\`Required +##### \`restorePatch\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patchType\`Optional +##### \`patchType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) +- *Type:* software.amazon.awscdk.services.eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -50271,9 +47254,9 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resourceNamespace\`Optional +##### \`resourceNamespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The kubernetes API namespace. @@ -50284,13 +47267,13 @@ The kubernetes API namespace. -### Nodegroup +### Nodegroup -- *Implements:* [\`software.amazon.awscdk.services.eks.INodegroup\`](#software.amazon.awscdk.services.eks.INodegroup) +- *Implements:* software.amazon.awscdk.services.eks.INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.Nodegroup; @@ -50319,62 +47302,62 @@ Nodegroup.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksnodegroupparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksnodegroupparameterid)* | \`java.lang.String\` | *No description.* | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegrouppropsparameteramitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegrouppropsparametercapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterdesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterdisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceType\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterinstancetype) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for your node group. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterlabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterlaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparametermaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropsparameternodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegrouppropsparameternoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegrouppropsparameterremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegrouppropsparametersubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegrouppropsparametertags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | Cluster resource. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceType | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for your node group. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | software.amazon.awscdk.services.eks.ICluster | Cluster resource. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`amiType\`Optional +##### \`amiType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -50383,18 +47366,18 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -50403,11 +47386,11 @@ If an update fails because pods could not be drained, you can force the update a --- -##### ~~\`instanceType\`~~Optional +##### ~~\`instanceType\`~~Optional - *Deprecated:* Use \`instanceTypes\` instead. -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* t3.medium The instance type to use for your node group. @@ -50416,40 +47399,40 @@ Currently, you can specify a single instance type for a node group. The default --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -50458,9 +47441,9 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -50469,18 +47452,18 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -50489,18 +47472,18 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -50509,9 +47492,9 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -50520,9 +47503,9 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -50531,24 +47514,24 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster Cluster resource. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromNodegroupName\`](#softwareamazonawscdkserviceseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| fromNodegroupName | Import the Nodegroup from attributes. | --- -##### \`fromNodegroupName\` +##### \`fromNodegroupName\` \`\`\`java import software.amazon.awscdk.services.eks.Nodegroup; @@ -50556,93 +47539,93 @@ import software.amazon.awscdk.services.eks.Nodegroup; Nodegroup.fromNodegroupName(Construct scope, java.lang.String id, java.lang.String nodegroupName) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -###### \`nodegroupName\`Required +###### \`nodegroupName\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | the Amazon EKS cluster resource. | -| [\`nodegroupArn\`](#softwareamazonawscdkserviceseksnodegrouppropertynodegrouparn)* | \`java.lang.String\` | ARN of the nodegroup. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropertynodegroupname)* | \`java.lang.String\` | Nodegroup name. | -| [\`role\`](#softwareamazonawscdkserviceseksnodegrouppropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | IAM role of the instance profile for the nodegroup. | +| cluster | software.amazon.awscdk.services.eks.ICluster | the Amazon EKS cluster resource. | +| nodegroupArn | java.lang.String | ARN of the nodegroup. | +| nodegroupName | java.lang.String | Nodegroup name. | +| role | software.amazon.awscdk.services.iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster the Amazon EKS cluster resource. --- -##### \`nodegroupArn\`Required +##### \`nodegroupArn\`Required \`\`\`java public java.lang.String getNodegroupArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String ARN of the nodegroup. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Nodegroup name. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.OpenIdConnectProvider; @@ -50654,31 +47637,31 @@ OpenIdConnectProvider.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksopenidconnectproviderparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | The definition scope. | -| [\`id\`](#softwareamazonawscdkserviceseksopenidconnectproviderparameterid)* | \`java.lang.String\` | Construct ID. | -| [\`url\`](#softwareamazonawscdkserviceseksopenidconnectproviderpropsparameterurl)* | \`java.lang.String\` | The URL of the identity provider. | +| scope | software.constructs.Construct | The definition scope. | +| id | java.lang.String | Construct ID. | +| url | java.lang.String | The URL of the identity provider. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct The definition scope. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Construct ID. --- -##### \`url\`Required +##### \`url\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URL of the identity provider. @@ -50690,13 +47673,13 @@ The URL must begin with https:// and should correspond to the iss claim in the p -### ServiceAccount +### ServiceAccount -- *Implements:* [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) +- *Implements:* software.amazon.awscdk.services.iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccount; @@ -50710,179 +47693,179 @@ ServiceAccount.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkserviceseksserviceaccountparameterscope)* | [\`software.constructs.Construct\`](#software.constructs.Construct) | *No description.* | -| [\`id\`](#softwareamazonawscdkserviceseksserviceaccountparameterid)* | \`java.lang.String\` | *No description.* | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountpropsparametername) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountpropsparameternamespace) | \`java.lang.String\` | The namespace of the service account. | -| [\`cluster\`](#softwareamazonawscdkserviceseksserviceaccountpropsparametercluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | +| scope | software.constructs.Construct | *No description.* | +| id | java.lang.String | *No description.* | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToPolicy\`](#softwareamazonawscdkserviceseksserviceaccountaddtopolicy) | Add to the policy of this principal. | -| [\`addToPrincipalPolicy\`](#softwareamazonawscdkserviceseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| addToPolicy | Add to the policy of this principal. | +| addToPrincipalPolicy | Add to the policy of this principal. | --- -##### ~~\`addToPolicy\`~~ +##### ~~\`addToPolicy\`~~ \`\`\`java public addToPolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -##### \`addToPrincipalPolicy\` +##### \`addToPrincipalPolicy\` \`\`\`java public addToPrincipalPolicy(PolicyStatement statement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`assumeRoleAction\`](#softwareamazonawscdkserviceseksserviceaccountpropertyassumeroleaction)* | \`java.lang.String\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`grantPrincipal\`](#softwareamazonawscdkserviceseksserviceaccountpropertygrantprincipal)* | [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) | The principal to grant permissions to. | -| [\`policyFragment\`](#softwareamazonawscdkserviceseksserviceaccountpropertypolicyfragment)* | [\`software.amazon.awscdk.services.iam.PrincipalPolicyFragment\`](#software.amazon.awscdk.services.iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`role\`](#softwareamazonawscdkserviceseksserviceaccountpropertyrole)* | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The role which is linked to the service account. | -| [\`serviceAccountName\`](#softwareamazonawscdkserviceseksserviceaccountpropertyserviceaccountname)* | \`java.lang.String\` | The name of the service account. | -| [\`serviceAccountNamespace\`](#softwareamazonawscdkserviceseksserviceaccountpropertyserviceaccountnamespace)* | \`java.lang.String\` | The namespace where the service account is located in. | +| assumeRoleAction | java.lang.String | When this Principal is used in an AssumeRole policy, the action to use. | +| grantPrincipal | software.amazon.awscdk.services.iam.IPrincipal | The principal to grant permissions to. | +| policyFragment | software.amazon.awscdk.services.iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| role | software.amazon.awscdk.services.iam.IRole | The role which is linked to the service account. | +| serviceAccountName | java.lang.String | The name of the service account. | +| serviceAccountNamespace | java.lang.String | The namespace where the service account is located in. | --- -##### \`assumeRoleAction\`Required +##### \`assumeRoleAction\`Required \`\`\`java public java.lang.String getAssumeRoleAction(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`grantPrincipal\`Required +##### \`grantPrincipal\`Required \`\`\`java public IPrincipal getGrantPrincipal(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IPrincipal\`](#software.amazon.awscdk.services.iam.IPrincipal) +- *Type:* software.amazon.awscdk.services.iam.IPrincipal The principal to grant permissions to. --- -##### \`policyFragment\`Required +##### \`policyFragment\`Required \`\`\`java public PrincipalPolicyFragment getPolicyFragment(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.PrincipalPolicyFragment\`](#software.amazon.awscdk.services.iam.PrincipalPolicyFragment) +- *Type:* software.amazon.awscdk.services.iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`role\`Required +##### \`role\`Required \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole The role which is linked to the service account. --- -##### \`serviceAccountName\`Required +##### \`serviceAccountName\`Required \`\`\`java public java.lang.String getServiceAccountName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the service account. --- -##### \`serviceAccountNamespace\`Required +##### \`serviceAccountNamespace\`Required \`\`\`java public java.lang.String getServiceAccountNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AutoScalingGroupCapacityOptions; @@ -50923,78 +47906,78 @@ AutoScalingGroupCapacityOptions.builder() .build(); \`\`\` -#### Properties - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`allowAllOutbound\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`java.lang.Boolean\` | Whether the instances can initiate connections to anywhere by default. | -| [\`associatePublicIpAddress\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`java.lang.Boolean\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`autoScalingGroupName\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`java.lang.String\` | The name of the Auto Scaling group. | -| [\`blockDevices\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyblockdevices) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.BlockDevice\`](#software.amazon.awscdk.services.autoscaling.BlockDevice)> | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`cooldown\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertycooldown) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`desiredCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`java.lang.Number\` | Initial amount of instances in the fleet. | -| [\`groupMetrics\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertygroupmetrics) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.GroupMetrics\`](#software.amazon.awscdk.services.autoscaling.GroupMetrics)> | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`healthCheck\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`software.amazon.awscdk.services.autoscaling.HealthCheck\`](#software.amazon.awscdk.services.autoscaling.HealthCheck) | Configuration for health checks. | -| [\`ignoreUnmodifiedSizeProperties\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`java.lang.Boolean\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`instanceMonitoring\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`software.amazon.awscdk.services.autoscaling.Monitoring\`](#software.amazon.awscdk.services.autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`keyName\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertykeyname) | \`java.lang.String\` | Name of SSH keypair to grant access to instances. | -| [\`maxCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`java.lang.Number\` | Maximum number of instances in the fleet. | -| [\`maxInstanceLifetime\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The maximum amount of time that an instance can be in service. | -| [\`minCapacity\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymincapacity) | \`java.lang.Number\` | Minimum number of instances in the fleet. | -| [\`newInstancesProtectedFromScaleIn\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`java.lang.Boolean\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`notifications\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertynotifications) | java.util.List<[\`software.amazon.awscdk.services.autoscaling.NotificationConfiguration\`](#software.amazon.awscdk.services.autoscaling.NotificationConfiguration)> | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`notificationsTopic\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertynotificationstopic) | [\`software.amazon.awscdk.services.sns.ITopic\`](#software.amazon.awscdk.services.sns.ITopic) | SNS topic to send notifications about fleet changes. | -| [\`replacingUpdateMinSuccessfulInstancesPercent\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyreplacingupdateminsuccessfulinstancespercent) | \`java.lang.Number\` | Configuration for replacing updates. | -| [\`resourceSignalCount\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyresourcesignalcount) | \`java.lang.Number\` | How many ResourceSignal calls CloudFormation expects before the resource is considered created. | -| [\`resourceSignalTimeout\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyresourcesignaltimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | The length of time to wait for the resourceSignalCount. | -| [\`rollingUpdateConfiguration\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyrollingupdateconfiguration) | [\`software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration\`](#software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration) | Configuration for rolling updates. | -| [\`signals\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertysignals) | [\`software.amazon.awscdk.services.autoscaling.Signals\`](#software.amazon.awscdk.services.autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`spotPrice\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyspotprice) | \`java.lang.String\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`updatePolicy\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`software.amazon.awscdk.services.autoscaling.UpdatePolicy\`](#software.amazon.awscdk.services.autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`updateType\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyupdatetype) | [\`software.amazon.awscdk.services.autoscaling.UpdateType\`](#software.amazon.awscdk.services.autoscaling.UpdateType) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`instanceType\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | Instance type of the instances to start. | -| [\`bootstrapEnabled\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`java.lang.Boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`machineImageType\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) | Machine image type. | -| [\`mapRole\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertymaprole) | \`java.lang.Boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#softwareamazonawscdkserviceseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`java.lang.Boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | - ---- - -##### \`allowAllOutbound\`Optional +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allowAllOutbound | java.lang.Boolean | Whether the instances can initiate connections to anywhere by default. | +| associatePublicIpAddress | java.lang.Boolean | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| autoScalingGroupName | java.lang.String | The name of the Auto Scaling group. | +| blockDevices | java.util.List | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| cooldown | software.amazon.awscdk.core.Duration | Default scaling cooldown for this AutoScalingGroup. | +| desiredCapacity | java.lang.Number | Initial amount of instances in the fleet. | +| groupMetrics | java.util.List | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| healthCheck | software.amazon.awscdk.services.autoscaling.HealthCheck | Configuration for health checks. | +| ignoreUnmodifiedSizeProperties | java.lang.Boolean | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| instanceMonitoring | software.amazon.awscdk.services.autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| keyName | java.lang.String | Name of SSH keypair to grant access to instances. | +| maxCapacity | java.lang.Number | Maximum number of instances in the fleet. | +| maxInstanceLifetime | software.amazon.awscdk.core.Duration | The maximum amount of time that an instance can be in service. | +| minCapacity | java.lang.Number | Minimum number of instances in the fleet. | +| newInstancesProtectedFromScaleIn | java.lang.Boolean | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| notifications | java.util.List | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| notificationsTopic | software.amazon.awscdk.services.sns.ITopic | SNS topic to send notifications about fleet changes. | +| replacingUpdateMinSuccessfulInstancesPercent | java.lang.Number | Configuration for replacing updates. | +| resourceSignalCount | java.lang.Number | How many ResourceSignal calls CloudFormation expects before the resource is considered created. | +| resourceSignalTimeout | software.amazon.awscdk.core.Duration | The length of time to wait for the resourceSignalCount. | +| rollingUpdateConfiguration | software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration | Configuration for rolling updates. | +| signals | software.amazon.awscdk.services.autoscaling.Signals | Configure waiting for signals during deployment. | +| spotPrice | java.lang.String | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| updatePolicy | software.amazon.awscdk.services.autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| updateType | software.amazon.awscdk.services.autoscaling.UpdateType | What to do when an AutoScalingGroup's instance configuration is changed. | +| vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | Where to place instances within the VPC. | +| instanceType | software.amazon.awscdk.services.ec2.InstanceType | Instance type of the instances to start. | +| bootstrapEnabled | java.lang.Boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | software.amazon.awscdk.services.eks.BootstrapOptions | EKS node bootstrapping options. | +| machineImageType | software.amazon.awscdk.services.eks.MachineImageType | Machine image type. | +| mapRole | java.lang.Boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | java.lang.Boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | + +--- + +##### \`allowAllOutbound\`Optional \`\`\`java public java.lang.Boolean getAllowAllOutbound(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`associatePublicIpAddress\`Optional +##### \`associatePublicIpAddress\`Optional \`\`\`java public java.lang.Boolean getAssociatePublicIpAddress(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`autoScalingGroupName\`Optional +##### \`autoScalingGroupName\`Optional \`\`\`java public java.lang.String getAutoScalingGroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -51003,60 +47986,60 @@ This name must be unique per Region per account. --- -##### \`blockDevices\`Optional +##### \`blockDevices\`Optional \`\`\`java public java.util.List getBlockDevices(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.BlockDevice\`](#software.amazon.awscdk.services.autoscaling.BlockDevice)> +- *Type:* java.util.List - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`cooldown\`Optional +##### \`cooldown\`Optional \`\`\`java public Duration getCooldown(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`desiredCapacity\`Optional +##### \`desiredCapacity\`Optional \`\`\`java public java.lang.Number getDesiredCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`groupMetrics\`Optional +##### \`groupMetrics\`Optional \`\`\`java public java.util.List getGroupMetrics(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.GroupMetrics\`](#software.amazon.awscdk.services.autoscaling.GroupMetrics)> +- *Type:* java.util.List - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -51065,26 +48048,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`healthCheck\`Optional +##### \`healthCheck\`Optional \`\`\`java public HealthCheck getHealthCheck(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.HealthCheck\`](#software.amazon.awscdk.services.autoscaling.HealthCheck) +- *Type:* software.amazon.awscdk.services.autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`ignoreUnmodifiedSizeProperties\`Optional +##### \`ignoreUnmodifiedSizeProperties\`Optional \`\`\`java public java.lang.Boolean getIgnoreUnmodifiedSizeProperties(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -51093,86 +48076,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`instanceMonitoring\`Optional +##### \`instanceMonitoring\`Optional \`\`\`java public Monitoring getInstanceMonitoring(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.Monitoring\`](#software.amazon.awscdk.services.autoscaling.Monitoring) +- *Type:* software.amazon.awscdk.services.autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`keyName\`Optional +##### \`keyName\`Optional \`\`\`java public java.lang.String getKeyName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`maxCapacity\`Optional +##### \`maxCapacity\`Optional \`\`\`java public java.lang.Number getMaxCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`maxInstanceLifetime\`Optional +##### \`maxInstanceLifetime\`Optional \`\`\`java public Duration getMaxInstanceLifetime(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`minCapacity\`Optional +##### \`minCapacity\`Optional \`\`\`java public java.lang.Number getMinCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`newInstancesProtectedFromScaleIn\`Optional +##### \`newInstancesProtectedFromScaleIn\`Optional \`\`\`java public java.lang.Boolean getNewInstancesProtectedFromScaleIn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -51181,22 +48164,22 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`notifications\`Optional +##### \`notifications\`Optional \`\`\`java public java.util.List getNotifications(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.autoscaling.NotificationConfiguration\`](#software.amazon.awscdk.services.autoscaling.NotificationConfiguration)> +- *Type:* java.util.List - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### ~~\`notificationsTopic\`~~Optional +##### ~~\`notificationsTopic\`~~Optional - *Deprecated:* use \`notifications\` @@ -51204,14 +48187,14 @@ Configure autoscaling group to send notifications about fleet changes to an SNS public ITopic getNotificationsTopic(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.sns.ITopic\`](#software.amazon.awscdk.services.sns.ITopic) +- *Type:* software.amazon.awscdk.services.sns.ITopic - *Default:* No fleet change notifications will be sent. SNS topic to send notifications about fleet changes. --- -##### ~~\`replacingUpdateMinSuccessfulInstancesPercent\`~~Optional +##### ~~\`replacingUpdateMinSuccessfulInstancesPercent\`~~Optional - *Deprecated:* Use \`signals\` instead @@ -51219,7 +48202,7 @@ SNS topic to send notifications about fleet changes. public java.lang.Number getReplacingUpdateMinSuccessfulInstancesPercent(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* minSuccessfulInstancesPercent Configuration for replacing updates. @@ -51228,7 +48211,7 @@ Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instan --- -##### ~~\`resourceSignalCount\`~~Optional +##### ~~\`resourceSignalCount\`~~Optional - *Deprecated:* Use \`signals\` instead. @@ -51236,14 +48219,14 @@ Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instan public java.lang.Number getResourceSignalCount(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 if resourceSignalTimeout is set, 0 otherwise How many ResourceSignal calls CloudFormation expects before the resource is considered created. --- -##### ~~\`resourceSignalTimeout\`~~Optional +##### ~~\`resourceSignalTimeout\`~~Optional - *Deprecated:* Use \`signals\` instead. @@ -51251,7 +48234,7 @@ How many ResourceSignal calls CloudFormation expects before the resource is cons public Duration getResourceSignalTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) if resourceSignalCount is set, N/A otherwise The length of time to wait for the resourceSignalCount. @@ -51260,7 +48243,7 @@ The maximum value is 43200 (12 hours). --- -##### ~~\`rollingUpdateConfiguration\`~~Optional +##### ~~\`rollingUpdateConfiguration\`~~Optional - *Deprecated:* Use \`updatePolicy\` instead @@ -51268,7 +48251,7 @@ The maximum value is 43200 (12 hours). public RollingUpdateConfiguration getRollingUpdateConfiguration(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration\`](#software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration) +- *Type:* software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration - *Default:* RollingUpdateConfiguration with defaults. Configuration for rolling updates. @@ -51277,13 +48260,13 @@ Only used if updateType == UpdateType.RollingUpdate. --- -##### \`signals\`Optional +##### \`signals\`Optional \`\`\`java public Signals getSignals(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.Signals\`](#software.amazon.awscdk.services.autoscaling.Signals) +- *Type:* software.amazon.awscdk.services.autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -51292,13 +48275,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`spotPrice\`Optional +##### \`spotPrice\`Optional \`\`\`java public java.lang.String getSpotPrice(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -51307,13 +48290,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`updatePolicy\`Optional +##### \`updatePolicy\`Optional \`\`\`java public UpdatePolicy getUpdatePolicy(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.UpdatePolicy\`](#software.amazon.awscdk.services.autoscaling.UpdatePolicy) +- *Type:* software.amazon.awscdk.services.autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -51322,7 +48305,7 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### ~~\`updateType\`~~Optional +##### ~~\`updateType\`~~Optional - *Deprecated:* Use \`updatePolicy\` instead @@ -51330,7 +48313,7 @@ This is applied when any of the settings on the ASG are changed that affect how public UpdateType getUpdateType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.autoscaling.UpdateType\`](#software.amazon.awscdk.services.autoscaling.UpdateType) +- *Type:* software.amazon.awscdk.services.autoscaling.UpdateType - *Default:* UpdateType.None What to do when an AutoScalingGroup's instance configuration is changed. @@ -51339,38 +48322,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public SubnetSelection getVpcSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`instanceType\`Required +##### \`instanceType\`Required \`\`\`java public InstanceType getInstanceType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType Instance type of the instances to start. --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`java public java.lang.Boolean getBootstrapEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -51379,39 +48362,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`java public BootstrapOptions getBootstrapOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) +- *Type:* software.amazon.awscdk.services.eks.BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`java public MachineImageType getMachineImageType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) +- *Type:* software.amazon.awscdk.services.eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`java public java.lang.Boolean getMapRole(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -51420,13 +48403,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`java public java.lang.Boolean getSpotInterruptHandler(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -51435,11 +48418,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AutoScalingGroupOptions; @@ -51453,25 +48436,25 @@ AutoScalingGroupOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`bootstrapEnabled\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertybootstrapenabled) | \`java.lang.Boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertybootstrapoptions) | [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`machineImageType\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertymachineimagetype) | [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`mapRole\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertymaprole) | \`java.lang.Boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#softwareamazonawscdkserviceseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`java.lang.Boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| bootstrapEnabled | java.lang.Boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | software.amazon.awscdk.services.eks.BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| machineImageType | software.amazon.awscdk.services.eks.MachineImageType | Allow options to specify different machine image type. | +| mapRole | java.lang.Boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | java.lang.Boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`java public java.lang.Boolean getBootstrapEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -51480,39 +48463,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`java public BootstrapOptions getBootstrapOptions(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.BootstrapOptions\`](#software.amazon.awscdk.services.eks.BootstrapOptions) +- *Type:* software.amazon.awscdk.services.eks.BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`java public MachineImageType getMachineImageType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.MachineImageType\`](#software.amazon.awscdk.services.eks.MachineImageType) +- *Type:* software.amazon.awscdk.services.eks.MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`java public java.lang.Boolean getMapRole(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -51521,13 +48504,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`java public java.lang.Boolean getSpotInterruptHandler(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -51536,11 +48519,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AwsAuthMapping; @@ -51551,47 +48534,47 @@ AwsAuthMapping.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`groups\`](#softwareamazonawscdkserviceseksawsauthmappingpropertygroups)* | java.util.List<\`java.lang.String\`> | A list of groups within Kubernetes to which the role is mapped. | -| [\`username\`](#softwareamazonawscdkserviceseksawsauthmappingpropertyusername) | \`java.lang.String\` | The user name within Kubernetes to map to the IAM role. | +| groups | java.util.List | A list of groups within Kubernetes to which the role is mapped. | +| username | java.lang.String | The user name within Kubernetes to map to the IAM role. | --- -##### \`groups\`Required +##### \`groups\`Required \`\`\`java public java.util.List getGroups(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`username\`Optional +##### \`username\`Optional \`\`\`java public java.lang.String getUsername(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.AwsAuthProps; @@ -51601,21 +48584,21 @@ AwsAuthProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkserviceseksawsauthpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply this configuration to. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply this configuration to. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public Cluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply this configuration to. @@ -51623,11 +48606,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.BootstrapOptions; @@ -51643,94 +48626,94 @@ BootstrapOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`additionalArgs\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyadditionalargs) | \`java.lang.String\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`awsApiRetryAttempts\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyawsapiretryattempts) | \`java.lang.Number\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`dnsClusterIp\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertydnsclusterip) | \`java.lang.String\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`dockerConfigJson\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertydockerconfigjson) | \`java.lang.String\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`enableDockerBridge\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyenabledockerbridge) | \`java.lang.Boolean\` | Restores the docker default bridge network. | -| [\`kubeletExtraArgs\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertykubeletextraargs) | \`java.lang.String\` | Extra arguments to add to the kubelet. | -| [\`useMaxPods\`](#softwareamazonawscdkserviceseksbootstrapoptionspropertyusemaxpods) | \`java.lang.Boolean\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| additionalArgs | java.lang.String | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| awsApiRetryAttempts | java.lang.Number | Number of retry attempts for AWS API call (DescribeCluster). | +| dnsClusterIp | java.lang.String | Overrides the IP address to use for DNS queries within the cluster. | +| dockerConfigJson | java.lang.String | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| enableDockerBridge | java.lang.Boolean | Restores the docker default bridge network. | +| kubeletExtraArgs | java.lang.String | Extra arguments to add to the kubelet. | +| useMaxPods | java.lang.Boolean | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`additionalArgs\`Optional +##### \`additionalArgs\`Optional \`\`\`java public java.lang.String getAdditionalArgs(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`awsApiRetryAttempts\`Optional +##### \`awsApiRetryAttempts\`Optional \`\`\`java public java.lang.Number getAwsApiRetryAttempts(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`dnsClusterIp\`Optional +##### \`dnsClusterIp\`Optional \`\`\`java public java.lang.String getDnsClusterIp(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`dockerConfigJson\`Optional +##### \`dockerConfigJson\`Optional \`\`\`java public java.lang.String getDockerConfigJson(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`enableDockerBridge\`Optional +##### \`enableDockerBridge\`Optional \`\`\`java public java.lang.Boolean getEnableDockerBridge(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Restores the docker default bridge network. --- -##### \`kubeletExtraArgs\`Optional +##### \`kubeletExtraArgs\`Optional \`\`\`java public java.lang.String getKubeletExtraArgs(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* none Extra arguments to add to the kubelet. @@ -51739,26 +48722,26 @@ Useful for adding labels or taints. --- -##### \`useMaxPods\`Optional +##### \`useMaxPods\`Optional \`\`\`java public java.lang.Boolean getUseMaxPods(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnAddonProps; @@ -51773,26 +48756,26 @@ CfnAddonProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`addonName\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyaddonname)* | \`java.lang.String\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyaddonversion) | \`java.lang.String\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyresolveconflicts) | \`java.lang.String\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#softwareamazonawscdkservicesekscfnaddonpropspropertyserviceaccountrolearn) | \`java.lang.String\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnaddonpropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::EKS::Addon.Tags\`. | +| addonName | java.lang.String | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | java.lang.String | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | java.lang.String | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | java.lang.String | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | java.lang.String | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | java.util.List | \`AWS::EKS::Addon.Tags\`. | --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`java public java.lang.String getAddonName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonName\`. @@ -51800,13 +48783,13 @@ public java.lang.String getAddonName(); --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ClusterName\`. @@ -51814,13 +48797,13 @@ public java.lang.String getClusterName(); --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`java public java.lang.String getAddonVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.AddonVersion\`. @@ -51828,13 +48811,13 @@ public java.lang.String getAddonVersion(); --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`java public java.lang.String getResolveConflicts(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ResolveConflicts\`. @@ -51842,13 +48825,13 @@ public java.lang.String getResolveConflicts(); --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`java public java.lang.String getServiceAccountRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -51856,13 +48839,13 @@ public java.lang.String getServiceAccountRoleArn(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::Addon.Tags\`. @@ -51870,13 +48853,13 @@ public java.util.List getTags(); --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnClusterProps; @@ -51895,26 +48878,26 @@ CfnClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`resourcesVpcConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyresourcesvpcconfig)* | [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyrolearn)* | \`java.lang.String\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyencryptionconfig) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#softwareamazonawscdkservicesekscfnclusterpropspropertykubernetesnetworkconfig) | [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyname) | \`java.lang.String\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnclusterpropspropertyversion) | \`java.lang.String\` | \`AWS::EKS::Cluster.Version\`. | +| resourcesVpcConfig | software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | java.lang.String | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | java.lang.String | \`AWS::EKS::Cluster.Name\`. | +| version | java.lang.String | \`AWS::EKS::Cluster.Version\`. | --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`java public java.lang.Object getResourcesVpcConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -51922,13 +48905,13 @@ public java.lang.Object getResourcesVpcConfig(); --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`java public java.lang.String getRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.RoleArn\`. @@ -51936,13 +48919,13 @@ public java.lang.String getRoleArn(); --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`java public java.lang.Object getEncryptionConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -51950,13 +48933,13 @@ public java.lang.Object getEncryptionConfig(); --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`java public java.lang.Object getKubernetesNetworkConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -51964,13 +48947,13 @@ public java.lang.Object getKubernetesNetworkConfig(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Name\`. @@ -51978,13 +48961,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Cluster.Version\`. @@ -51992,13 +48975,13 @@ public java.lang.String getVersion(); --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfileProps; @@ -52015,26 +48998,26 @@ CfnFargateProfileProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`java.lang.String\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyselectors)* | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertyfargateprofilename) | \`java.lang.String\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertysubnets) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnfargateprofilepropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | java.lang.String | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | java.lang.String | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | java.lang.String | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | java.util.List | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | java.util.List | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.ClusterName\`. @@ -52042,13 +49025,13 @@ public java.lang.String getClusterName(); --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`java public java.lang.String getPodExecutionRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -52056,13 +49039,13 @@ public java.lang.String getPodExecutionRoleArn(); --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.lang.Object getSelectors(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::FargateProfile.Selectors\`. @@ -52070,13 +49053,13 @@ public java.lang.Object getSelectors(); --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -52084,13 +49067,13 @@ public java.lang.String getFargateProfileName(); --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Subnets\`. @@ -52098,13 +49081,13 @@ public java.util.List getSubnets(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::EKS::FargateProfile.Tags\`. @@ -52112,13 +49095,13 @@ public java.util.List getTags(); --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroupProps; @@ -52150,37 +49133,37 @@ CfnNodegroupProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyclustername)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`nodeRole\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertynoderole)* | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertysubnets)* | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyamitype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertycapacitytype) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertydisksize) | \`java.lang.Number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyforceupdateenabled) | \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyinstancetypes) | java.util.List<\`java.lang.String\`> | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertylabels) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launchTemplate\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertylaunchtemplate) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertynodegroupname) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyreleaseversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyscalingconfig) | [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertytags) | \`java.lang.Object\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertytaints) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouppropspropertyversion) | \`java.lang.String\` | \`AWS::EKS::Nodegroup.Version\`. | +| clusterName | java.lang.String | \`AWS::EKS::Nodegroup.ClusterName\`. | +| nodeRole | java.lang.String | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | java.util.List | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | java.lang.String | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | java.lang.String | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | java.lang.Number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | java.lang.Boolean OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | java.util.List | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | java.lang.Object | \`AWS::EKS::Nodegroup.Labels\`. | +| launchTemplate | software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | java.lang.String | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | java.lang.String | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | java.lang.Object | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | software.amazon.awscdk.core.IResolvable OR java.util.List | \`AWS::EKS::Nodegroup.Taints\`. | +| version | java.lang.String | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ClusterName\`. @@ -52188,13 +49171,13 @@ public java.lang.String getClusterName(); --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`java public java.lang.String getNodeRole(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodeRole\`. @@ -52202,13 +49185,13 @@ public java.lang.String getNodeRole(); --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`java public java.util.List getSubnets(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.Subnets\`. @@ -52216,13 +49199,13 @@ public java.util.List getSubnets(); --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public java.lang.String getAmiType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.AmiType\`. @@ -52230,13 +49213,13 @@ public java.lang.String getAmiType(); --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public java.lang.String getCapacityType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.CapacityType\`. @@ -52244,13 +49227,13 @@ public java.lang.String getCapacityType(); --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -52258,13 +49241,13 @@ public java.lang.Number getDiskSize(); --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`java public java.lang.Object getForceUpdateEnabled(); \`\`\` -- *Type:* \`java.lang.Boolean\` OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* java.lang.Boolean OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -52272,13 +49255,13 @@ public java.lang.Object getForceUpdateEnabled(); --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -52286,13 +49269,13 @@ public java.util.List getInstanceTypes(); --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Labels\`. @@ -52300,13 +49283,13 @@ public java.lang.Object getLabels(); --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`java public java.lang.Object getLaunchTemplate(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -52314,13 +49297,13 @@ public java.lang.Object getLaunchTemplate(); --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -52328,13 +49311,13 @@ public java.lang.String getNodegroupName(); --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -52342,13 +49325,13 @@ public java.lang.String getReleaseVersion(); --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public java.lang.Object getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -52356,13 +49339,13 @@ public java.lang.Object getRemoteAccess(); --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`java public java.lang.Object getScalingConfig(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty OR software.amazon.awscdk.core.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -52370,13 +49353,13 @@ public java.lang.Object getScalingConfig(); --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.lang.Object getTags(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::EKS::Nodegroup.Tags\`. @@ -52384,13 +49367,13 @@ public java.lang.Object getTags(); --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`java public java.lang.Object getTaints(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty\`](#software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`AWS::EKS::Nodegroup.Taints\`. @@ -52398,13 +49381,13 @@ public java.lang.Object getTaints(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::EKS::Nodegroup.Version\`. @@ -52412,11 +49395,11 @@ public java.lang.String getVersion(); --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterAttributes; @@ -52440,112 +49423,112 @@ ClusterAttributes.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustername)* | \`java.lang.String\` | The physical name of the Cluster. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustercertificateauthoritydata) | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksclusterattributespropertyclusterendpoint) | \`java.lang.String\` | The API Server endpoint URL. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterattributespropertyclustersecuritygroupid) | \`java.lang.String\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlenvironment) | java.util.Map | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnetIds\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlprivatesubnetids) | java.util.List<\`java.lang.String\`> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRoleArn\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlrolearn) | \`java.lang.String\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`kubectlSecurityGroupId\`](#softwareamazonawscdkserviceseksclusterattributespropertykubectlsecuritygroupid) | \`java.lang.String\` | A security group to use for \`kubectl\` execution. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksclusterattributespropertyopenidconnectprovider) | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterattributespropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`securityGroupIds\`](#softwareamazonawscdkserviceseksclusterattributespropertysecuritygroupids) | java.util.List<\`java.lang.String\`> | Additional security groups associated with this cluster. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterattributespropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | +| clusterName | java.lang.String | The physical name of the Cluster. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The API Server endpoint URL. | +| clusterSecurityGroupId | java.lang.String | The cluster security group that was created by Amazon EKS for the cluster. | +| kubectlEnvironment | java.util.Map | Environment variables to use when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnetIds | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRoleArn | java.lang.String | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| kubectlSecurityGroupId | java.lang.String | A security group to use for \`kubectl\` execution. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| securityGroupIds | java.util.List | Additional security groups associated with this cluster. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The physical name of the Cluster. --- -##### \`clusterCertificateAuthorityData\`Optional +##### \`clusterCertificateAuthorityData\`Optional \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Optional +##### \`clusterEncryptionConfigKeyArn\`Optional \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Optional +##### \`clusterEndpoint\`Optional \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`clusterSecurityGroupId\`Optional +##### \`clusterSecurityGroupId\`Optional \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -52554,26 +49537,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnetIds\`Optional +##### \`kubectlPrivateSubnetIds\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnetIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -52582,26 +49565,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRoleArn\`Optional +##### \`kubectlRoleArn\`Optional \`\`\`java public java.lang.String getKubectlRoleArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`kubectlSecurityGroupId\`Optional +##### \`kubectlSecurityGroupId\`Optional \`\`\`java public java.lang.String getKubectlSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -52610,13 +49593,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`openIdConnectProvider\`Optional +##### \`openIdConnectProvider\`Optional \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -52625,13 +49608,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -52640,37 +49623,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`java public java.util.List getSecurityGroupIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterOptions; @@ -52698,77 +49681,77 @@ ClusterOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksclusteroptionspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusteroptionspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusteroptionspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusteroptionspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusteroptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusteroptionspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusteroptionspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusteroptionspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusteroptionspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusteroptionspropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusteroptionspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusteroptionspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusteroptionspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusteroptionspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -52777,52 +49760,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -52831,54 +49814,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -52887,84 +49870,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -52973,24 +49956,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ClusterProps; @@ -53021,80 +50004,80 @@ ClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksclusterpropspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksclusterpropspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksclusterpropspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksclusterpropspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksclusterpropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksclusterpropspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksclusterpropspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksclusterpropspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksclusterpropspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksclusterpropspropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksclusterpropspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksclusterpropspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksclusterpropspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksclusterpropspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksclusterpropspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultCapacity\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacity) | \`java.lang.Number\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`defaultCapacityInstance\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacityinstance) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`defaultCapacityType\`](#softwareamazonawscdkserviceseksclusterpropspropertydefaultcapacitytype) | [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) | The default capacity type for the cluster. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultCapacity | java.lang.Number | Number of instances to allocate as an initial capacity for this cluster. | +| defaultCapacityInstance | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for the default capacity. | +| defaultCapacityType | software.amazon.awscdk.services.eks.DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -53103,52 +50086,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -53157,54 +50140,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -53213,84 +50196,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -53299,26 +50282,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`java public java.lang.Number getDefaultCapacity(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -53327,13 +50310,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`defaultCapacityInstance\`Optional +##### \`defaultCapacityInstance\`Optional \`\`\`java public InstanceType getDefaultCapacityInstance(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -53342,24 +50325,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`defaultCapacityType\`Optional +##### \`defaultCapacityType\`Optional \`\`\`java public DefaultCapacityType getDefaultCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.DefaultCapacityType\`](#software.amazon.awscdk.services.eks.DefaultCapacityType) +- *Type:* software.amazon.awscdk.services.eks.DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CommonClusterOptions; @@ -53376,66 +50359,66 @@ CommonClusterOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkservicesekscommonclusteroptionspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -53444,52 +50427,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -53498,11 +50481,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.EksOptimizedImageProps; @@ -53514,60 +50497,60 @@ EksOptimizedImageProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpuArch\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertycpuarch) | [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetesVersion\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertykubernetesversion) | \`java.lang.String\` | The Kubernetes version to use. | -| [\`nodeType\`](#softwareamazonawscdkservicesekseksoptimizedimagepropspropertynodetype) | [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpuArch | software.amazon.awscdk.services.eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetesVersion | java.lang.String | The Kubernetes version to use. | +| nodeType | software.amazon.awscdk.services.eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpuArch\`Optional +##### \`cpuArch\`Optional \`\`\`java public CpuArch getCpuArch(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) +- *Type:* software.amazon.awscdk.services.eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetesVersion\`Optional +##### \`kubernetesVersion\`Optional \`\`\`java public java.lang.String getKubernetesVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest version The Kubernetes version to use. --- -##### \`nodeType\`Optional +##### \`nodeType\`Optional \`\`\`java public NodeType getNodeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) +- *Type:* software.amazon.awscdk.services.eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.EncryptionConfigProperty; @@ -53579,22 +50562,22 @@ EncryptionConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`provider\`](#softwareamazonawscdkservicesekscfnclusterencryptionconfigpropertypropertyprovider) | [\`software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`resources\`](#softwareamazonawscdkservicesekscfnclusterencryptionconfigpropertypropertyresources) | java.util.List<\`java.lang.String\`> | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| provider | software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty OR software.amazon.awscdk.core.IResolvable | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| resources | java.util.List | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`provider\`Optional +##### \`provider\`Optional \`\`\`java public java.lang.Object getProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty\`](#software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) +- *Type:* software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty OR software.amazon.awscdk.core.IResolvable \`CfnCluster.EncryptionConfigProperty.Provider\`. @@ -53602,13 +50585,13 @@ public java.lang.Object getProvider(); --- -##### \`resources\`Optional +##### \`resources\`Optional \`\`\`java public java.util.List getResources(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -53616,11 +50599,11 @@ public java.util.List getResources(); --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateClusterProps; @@ -53649,78 +50632,78 @@ FargateClusterProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyversion)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyclustername) | \`java.lang.String\` | Name for the cluster. | -| [\`outputClusterName\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputclustername) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputconfigcommand) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertysecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyvpcsubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyclusterhandlerenvironment) | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertycorednscomputetype) | [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyendpointaccess) | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectlenvironment) | java.util.Map | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertymastersrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyoutputmastersrolearn) | \`java.lang.Boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`java.lang.Boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertyprune) | \`java.lang.Boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertysecretsencryptionkey) | [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultProfile\`](#softwareamazonawscdkserviceseksfargateclusterpropspropertydefaultprofile) | [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| version | software.amazon.awscdk.services.eks.KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | java.lang.String | Name for the cluster. | +| outputClusterName | java.lang.Boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | java.lang.Boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | software.amazon.awscdk.services.iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | java.util.List | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | java.util.Map | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | software.amazon.awscdk.services.eks.CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | software.amazon.awscdk.services.eks.EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | java.util.Map | Environment variables for the kubectl execution. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | software.amazon.awscdk.services.iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | java.lang.Boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | java.lang.Boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | software.amazon.awscdk.services.kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultProfile | software.amazon.awscdk.services.eks.FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public KubernetesVersion getVersion(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`java public java.lang.Boolean getOutputClusterName(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`java public java.lang.Boolean getOutputConfigCommand(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -53729,52 +50712,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`java public IRole getRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`java public ISecurityGroup getSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`java public java.util.List getVpcSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection)> +- *Type:* java.util.List - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -53783,54 +50766,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`java public java.util.Map getClusterHandlerEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`java public CoreDnsComputeType getCoreDnsComputeType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CoreDnsComputeType\`](#software.amazon.awscdk.services.eks.CoreDnsComputeType) +- *Type:* software.amazon.awscdk.services.eks.CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`java public EndpointAccess getEndpointAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -53839,84 +50822,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`java // Example automatically generated from non-compiling source. May contain errors. Object layer = LayerVersion.Builder.create(this, \\"kubectl-layer\\") .code(lambda.Code.fromAsset(String.format(\\"%s/layer.zip\\", __dirname))) .build();[lambda.Runtime.PROVIDED] compatibleRuntimes; \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`java public IRole getMastersRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`java public java.lang.Boolean getOutputMastersRoleArn(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`java public java.lang.Boolean getPlaceClusterHandlerInVpc(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -53925,37 +50908,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`java public IKey getSecretsEncryptionKey(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.kms.IKey\`](#software.amazon.awscdk.services.kms.IKey) +- *Type:* software.amazon.awscdk.services.kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultProfile\`Optional +##### \`defaultProfile\`Optional \`\`\`java public FargateProfileOptions getDefaultProfile(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.FargateProfileOptions\`](#software.amazon.awscdk.services.eks.FargateProfileOptions) +- *Type:* software.amazon.awscdk.services.eks.FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateProfileOptions; @@ -53969,25 +50952,25 @@ FargateProfileOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertypodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertysubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofileoptionspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.util.List getSelectors(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -53995,43 +50978,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`java public SubnetSelection getSubnetSelection(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -54040,13 +51023,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -54055,11 +51038,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.FargateProfileProps; @@ -54074,26 +51057,26 @@ FargateProfileProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyselectors)* | java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyfargateprofilename) | \`java.lang.String\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertypodexecutionrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertysubnetselection) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertyvpc) | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#softwareamazonawscdkserviceseksfargateprofilepropspropertycluster)* | [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| selectors | java.util.List | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | java.lang.String | The name of the Fargate profile. | +| podExecutionRole | software.amazon.awscdk.services.iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | software.amazon.awscdk.services.ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | software.amazon.awscdk.services.eks.Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`java public java.util.List getSelectors(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.eks.Selector\`](#software.amazon.awscdk.services.eks.Selector)> +- *Type:* java.util.List The selectors to match for pods to use this Fargate profile. @@ -54101,43 +51084,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`java public java.lang.String getFargateProfileName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`java public IRole getPodExecutionRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`java public SubnetSelection getSubnetSelection(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -54146,13 +51129,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -54161,13 +51144,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public Cluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster) +- *Type:* software.amazon.awscdk.services.eks.Cluster The EKS cluster to apply the Fargate profile to. @@ -54175,11 +51158,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.HelmChartOptions; @@ -54197,80 +51180,80 @@ HelmChartOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartoptionspropertychart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartoptionspropertycreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartoptionspropertynamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartoptionspropertytimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyvalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartoptionspropertyversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartoptionspropertywait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.core.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`java public java.lang.String getChart(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`java public java.lang.Boolean getCreateNamespace(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`java public java.lang.String getRelease(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`java public java.lang.String getRepository(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -54279,13 +51262,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -54294,50 +51277,50 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`java public java.util.Map getValues(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`java public java.lang.Boolean getWait(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.HelmChartProps; @@ -54356,81 +51339,81 @@ HelmChartProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#softwareamazonawscdkservicesekshelmchartpropspropertychart)* | \`java.lang.String\` | The name of the chart. | -| [\`createNamespace\`](#softwareamazonawscdkservicesekshelmchartpropspropertycreatenamespace) | \`java.lang.Boolean\` | create namespace if not exist. | -| [\`namespace\`](#softwareamazonawscdkservicesekshelmchartpropspropertynamespace) | \`java.lang.String\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#softwareamazonawscdkservicesekshelmchartpropspropertyrelease) | \`java.lang.String\` | The name of the release. | -| [\`repository\`](#softwareamazonawscdkservicesekshelmchartpropspropertyrepository) | \`java.lang.String\` | The repository which contains the chart. | -| [\`timeout\`](#softwareamazonawscdkservicesekshelmchartpropspropertytimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#softwareamazonawscdkservicesekshelmchartpropspropertyvalues) | java.util.Map | The values to be used by the chart. | -| [\`version\`](#softwareamazonawscdkservicesekshelmchartpropspropertyversion) | \`java.lang.String\` | The chart version to install. | -| [\`wait\`](#softwareamazonawscdkservicesekshelmchartpropspropertywait) | \`java.lang.Boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#softwareamazonawscdkservicesekshelmchartpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this configuration to. | +| chart | java.lang.String | The name of the chart. | +| createNamespace | java.lang.Boolean | create namespace if not exist. | +| namespace | java.lang.String | The Kubernetes namespace scope of the requests. | +| release | java.lang.String | The name of the release. | +| repository | java.lang.String | The repository which contains the chart. | +| timeout | software.amazon.awscdk.core.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | java.util.Map | The values to be used by the chart. | +| version | java.lang.String | The chart version to install. | +| wait | java.lang.Boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this configuration to. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`java public java.lang.String getChart(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`java public java.lang.Boolean getCreateNamespace(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`java public java.lang.String getRelease(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`java public java.lang.String getRepository(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -54439,13 +51422,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -54454,52 +51437,52 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`java public java.util.Map getValues(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`java public java.lang.Boolean getWait(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this configuration to. @@ -54507,11 +51490,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifestOptions; @@ -54522,50 +51505,50 @@ KubernetesManifestOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestoptionspropertyprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestoptionspropertyskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`java public java.lang.Boolean getSkipValidation(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesManifestProps; @@ -54579,55 +51562,55 @@ KubernetesManifestProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyprune) | \`java.lang.Boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyskipvalidation) | \`java.lang.Boolean\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertymanifest)* | java.util.List> | The manifest to apply. | -| [\`overwrite\`](#softwareamazonawscdkservicesekskubernetesmanifestpropspropertyoverwrite) | \`java.lang.Boolean\` | Overwrite any existing resources. | +| prune | java.lang.Boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | java.lang.Boolean | A flag to signify if the manifest validation should be skipped. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to apply this manifest to. | +| manifest | java.util.List> | The manifest to apply. | +| overwrite | java.lang.Boolean | Overwrite any existing resources. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`java public java.lang.Boolean getSkipValidation(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to apply this manifest to. @@ -54635,13 +51618,13 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required \`\`\`java public java.util.List> getManifest(); \`\`\` -- *Type:* java.util.List> +- *Type:* java.util.List> The manifest to apply. @@ -54649,13 +51632,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional \`\`\`java public java.lang.Boolean getOverwrite(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* false Overwrite any existing resources. @@ -54664,11 +51647,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.KubernetesNetworkConfigProperty; @@ -54678,21 +51661,21 @@ KubernetesNetworkConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`serviceIpv4Cidr\`](#softwareamazonawscdkservicesekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`java.lang.String\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| serviceIpv4Cidr | java.lang.String | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`serviceIpv4Cidr\`Optional +##### \`serviceIpv4Cidr\`Optional \`\`\`java public java.lang.String getServiceIpv4Cidr(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -54700,11 +51683,11 @@ public java.lang.String getServiceIpv4Cidr(); --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesObjectValueProps; @@ -54719,26 +51702,26 @@ KubernetesObjectValueProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`jsonPath\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyjsonpath)* | \`java.lang.String\` | JSONPath to the specific value. | -| [\`objectName\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjectname)* | \`java.lang.String\` | The name of the object to query. | -| [\`objectType\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjecttype)* | \`java.lang.String\` | The object type to query. | -| [\`objectNamespace\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertyobjectnamespace) | \`java.lang.String\` | The namespace the object belongs to. | -| [\`timeout\`](#softwareamazonawscdkservicesekskubernetesobjectvaluepropspropertytimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Timeout for waiting on a value. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The EKS cluster to fetch attributes from. | +| jsonPath | java.lang.String | JSONPath to the specific value. | +| objectName | java.lang.String | The name of the object to query. | +| objectType | java.lang.String | The object type to query. | +| objectNamespace | java.lang.String | The namespace the object belongs to. | +| timeout | software.amazon.awscdk.core.Duration | Timeout for waiting on a value. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The EKS cluster to fetch attributes from. @@ -54746,39 +51729,39 @@ The EKS cluster to fetch attributes from. --- -##### \`jsonPath\`Required +##### \`jsonPath\`Required \`\`\`java public java.lang.String getJsonPath(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`objectName\`Required +##### \`objectName\`Required \`\`\`java public java.lang.String getObjectName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the object to query. --- -##### \`objectType\`Required +##### \`objectType\`Required \`\`\`java public java.lang.String getObjectType(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The object type to query. @@ -54786,37 +51769,37 @@ The object type to query. --- -##### \`objectNamespace\`Optional +##### \`objectNamespace\`Optional \`\`\`java public java.lang.String getObjectNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.KubernetesPatchProps; @@ -54831,38 +51814,38 @@ KubernetesPatchProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`applyPatch\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyapplypatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | -| [\`resourceName\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyresourcename)* | \`java.lang.String\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restorePatch\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyrestorepatch)* | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patchType\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertypatchtype) | [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resourceNamespace\`](#softwareamazonawscdkservicesekskubernetespatchpropspropertyresourcenamespace) | \`java.lang.String\` | The kubernetes API namespace. | +| applyPatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | +| resourceName | java.lang.String | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restorePatch | java.util.Map | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patchType | software.amazon.awscdk.services.eks.PatchType | The patch type to pass to \`kubectl patch\`. | +| resourceNamespace | java.lang.String | The kubernetes API namespace. | --- -##### \`applyPatch\`Required +##### \`applyPatch\`Required \`\`\`java public java.util.Map getApplyPatch(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. @@ -54870,37 +51853,37 @@ The cluster to apply the patch to. --- -##### \`resourceName\`Required +##### \`resourceName\`Required \`\`\`java public java.lang.String getResourceName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restorePatch\`Required +##### \`restorePatch\`Required \`\`\`java public java.util.Map getRestorePatch(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patchType\`Optional +##### \`patchType\`Optional \`\`\`java public PatchType getPatchType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.PatchType\`](#software.amazon.awscdk.services.eks.PatchType) +- *Type:* software.amazon.awscdk.services.eks.PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -54909,24 +51892,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resourceNamespace\`Optional +##### \`resourceNamespace\`Optional \`\`\`java public java.lang.String getResourceNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty; @@ -54937,22 +51920,22 @@ LabelProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`key\`](#softwareamazonawscdkservicesekscfnfargateprofilelabelpropertypropertykey)* | \`java.lang.String\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`value\`](#softwareamazonawscdkservicesekscfnfargateprofilelabelpropertypropertyvalue)* | \`java.lang.String\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| key | java.lang.String | \`CfnFargateProfile.LabelProperty.Key\`. | +| value | java.lang.String | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`key\`Required +##### \`key\`Required \`\`\`java public java.lang.String getKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.LabelProperty.Key\`. @@ -54960,13 +51943,13 @@ public java.lang.String getKey(); --- -##### \`value\`Required +##### \`value\`Required \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.LabelProperty.Value\`. @@ -54974,11 +51957,11 @@ public java.lang.String getValue(); --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.LaunchTemplateSpec; @@ -54989,45 +51972,45 @@ LaunchTemplateSpec.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#softwareamazonawscdkservicesekslaunchtemplatespecpropertyid)* | \`java.lang.String\` | The Launch template ID. | -| [\`version\`](#softwareamazonawscdkservicesekslaunchtemplatespecpropertyversion) | \`java.lang.String\` | The launch template version to be used (optional). | +| id | java.lang.String | The Launch template ID. | +| version | java.lang.String | The launch template version to be used (optional). | --- -##### \`id\`Required +##### \`id\`Required \`\`\`java public java.lang.String getId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Launch template ID. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.LaunchTemplateSpecificationProperty; @@ -55039,23 +52022,23 @@ LaunchTemplateSpecificationProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`name\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`version\`](#softwareamazonawscdkservicesekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`java.lang.String\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| id | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| name | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| version | java.lang.String | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`id\`Optional +##### \`id\`Optional \`\`\`java public java.lang.String getId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -55063,13 +52046,13 @@ public java.lang.String getId(); --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -55077,13 +52060,13 @@ public java.lang.String getName(); --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -55091,11 +52074,11 @@ public java.lang.String getVersion(); --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupOptions; @@ -55121,63 +52104,63 @@ NodegroupOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyamitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertycapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertydesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertydisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceType\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyinstancetype) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for your node group. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertylabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertylaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertymaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertynodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertynoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertysubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegroupoptionspropertytags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceType | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for your node group. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public NodegroupAmiType getAmiType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public CapacityType getCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -55186,26 +52169,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`java public java.lang.Boolean getForceUpdate(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -55214,7 +52197,7 @@ If an update fails because pods could not be drained, you can force the update a --- -##### ~~\`instanceType\`~~Optional +##### ~~\`instanceType\`~~Optional - *Deprecated:* Use \`instanceTypes\` instead. @@ -55222,7 +52205,7 @@ If an update fails because pods could not be drained, you can force the update a public InstanceType getInstanceType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* t3.medium The instance type to use for your node group. @@ -55231,56 +52214,56 @@ Currently, you can specify a single instance type for a node group. The default --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`java public LaunchTemplateSpec getLaunchTemplateSpec(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -55289,13 +52272,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -55304,26 +52287,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`java public IRole getNodeRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -55332,26 +52315,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public NodegroupRemoteAccess getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -55360,13 +52343,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public SubnetSelection getSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -55375,13 +52358,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.Map getTags(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -55390,11 +52373,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupProps; @@ -55421,64 +52404,64 @@ NodegroupProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyamitype) | [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#softwareamazonawscdkserviceseksnodegrouppropspropertycapacitytype) | [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertydesiredsize) | \`java.lang.Number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertydisksize) | \`java.lang.Number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyforceupdate) | \`java.lang.Boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceType\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyinstancetype) | [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) | The instance type to use for your node group. | -| [\`instanceTypes\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyinstancetypes) | java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> | The instance types to use for your node group. | -| [\`labels\`](#softwareamazonawscdkserviceseksnodegrouppropspropertylabels) | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#softwareamazonawscdkserviceseksnodegrouppropspropertylaunchtemplatespec) | [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertymaxsize) | \`java.lang.Number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyminsize) | \`java.lang.Number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksnodegrouppropspropertynodegroupname) | \`java.lang.String\` | Name of the Nodegroup. | -| [\`nodeRole\`](#softwareamazonawscdkserviceseksnodegrouppropspropertynoderole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyreleaseversion) | \`java.lang.String\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#softwareamazonawscdkserviceseksnodegrouppropspropertyremoteaccess) | [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#softwareamazonawscdkserviceseksnodegrouppropspropertysubnets) | [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#softwareamazonawscdkserviceseksnodegrouppropspropertytags) | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#softwareamazonawscdkserviceseksnodegrouppropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | Cluster resource. | +| amiType | software.amazon.awscdk.services.eks.NodegroupAmiType | The AMI type for your node group. | +| capacityType | software.amazon.awscdk.services.eks.CapacityType | The capacity type of the nodegroup. | +| desiredSize | java.lang.Number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | java.lang.Number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | java.lang.Boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceType | software.amazon.awscdk.services.ec2.InstanceType | The instance type to use for your node group. | +| instanceTypes | java.util.List | The instance types to use for your node group. | +| labels | java.util.Map | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | software.amazon.awscdk.services.eks.LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | java.lang.Number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | java.lang.Number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | java.lang.String | Name of the Nodegroup. | +| nodeRole | software.amazon.awscdk.services.iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | java.lang.String | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | software.amazon.awscdk.services.eks.NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | software.amazon.awscdk.services.ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | java.util.Map | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | software.amazon.awscdk.services.eks.ICluster | Cluster resource. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`java public NodegroupAmiType getAmiType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupAmiType\`](#software.amazon.awscdk.services.eks.NodegroupAmiType) +- *Type:* software.amazon.awscdk.services.eks.NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`java public CapacityType getCapacityType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.CapacityType\`](#software.amazon.awscdk.services.eks.CapacityType) +- *Type:* software.amazon.awscdk.services.eks.CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -55487,26 +52470,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`java public java.lang.Number getDiskSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`java public java.lang.Boolean getForceUpdate(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -55515,7 +52498,7 @@ If an update fails because pods could not be drained, you can force the update a --- -##### ~~\`instanceType\`~~Optional +##### ~~\`instanceType\`~~Optional - *Deprecated:* Use \`instanceTypes\` instead. @@ -55523,7 +52506,7 @@ If an update fails because pods could not be drained, you can force the update a public InstanceType getInstanceType(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType) +- *Type:* software.amazon.awscdk.services.ec2.InstanceType - *Default:* t3.medium The instance type to use for your node group. @@ -55532,56 +52515,56 @@ Currently, you can specify a single instance type for a node group. The default --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`java public java.util.List getInstanceTypes(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.InstanceType\`](#software.amazon.awscdk.services.ec2.InstanceType)> +- *Type:* java.util.List - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`java public LaunchTemplateSpec getLaunchTemplateSpec(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.LaunchTemplateSpec\`](#software.amazon.awscdk.services.eks.LaunchTemplateSpec) +- *Type:* software.amazon.awscdk.services.eks.LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -55590,13 +52573,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -55605,26 +52588,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`java public IRole getNodeRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -55633,26 +52616,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`java public java.lang.String getReleaseVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`java public NodegroupRemoteAccess getRemoteAccess(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.NodegroupRemoteAccess\`](#software.amazon.awscdk.services.eks.NodegroupRemoteAccess) +- *Type:* software.amazon.awscdk.services.eks.NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -55661,13 +52644,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`java public SubnetSelection getSubnets(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.SubnetSelection\`](#software.amazon.awscdk.services.ec2.SubnetSelection) +- *Type:* software.amazon.awscdk.services.ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -55676,13 +52659,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`java public java.util.Map getTags(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -55691,25 +52674,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.NodegroupRemoteAccess; @@ -55720,34 +52703,34 @@ NodegroupRemoteAccess.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`sshKeyName\`](#softwareamazonawscdkserviceseksnodegroupremoteaccesspropertysshkeyname)* | \`java.lang.String\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`sourceSecurityGroups\`](#softwareamazonawscdkserviceseksnodegroupremoteaccesspropertysourcesecuritygroups) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| sshKeyName | java.lang.String | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| sourceSecurityGroups | java.util.List | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`sshKeyName\`Required +##### \`sshKeyName\`Required \`\`\`java public java.lang.String getSshKeyName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`java public java.util.List getSourceSecurityGroups(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup)> +- *Type:* java.util.List - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -55756,11 +52739,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.OpenIdConnectProviderProps; @@ -55770,21 +52753,21 @@ OpenIdConnectProviderProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`url\`](#softwareamazonawscdkserviceseksopenidconnectproviderpropspropertyurl)* | \`java.lang.String\` | The URL of the identity provider. | +| url | java.lang.String | The URL of the identity provider. | --- -##### \`url\`Required +##### \`url\`Required \`\`\`java public java.lang.String getUrl(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URL of the identity provider. @@ -55792,11 +52775,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.ProviderProperty; @@ -55806,21 +52789,21 @@ ProviderProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`keyArn\`](#softwareamazonawscdkservicesekscfnclusterproviderpropertypropertykeyarn) | \`java.lang.String\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| keyArn | java.lang.String | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`keyArn\`Optional +##### \`keyArn\`Optional \`\`\`java public java.lang.String getKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnCluster.ProviderProperty.KeyArn\`. @@ -55828,11 +52811,11 @@ public java.lang.String getKeyArn(); --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.RemoteAccessProperty; @@ -55843,22 +52826,22 @@ RemoteAccessProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ec2SshKey\`](#softwareamazonawscdkservicesekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`java.lang.String\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`sourceSecurityGroups\`](#softwareamazonawscdkservicesekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | java.util.List<\`java.lang.String\`> | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| ec2SshKey | java.lang.String | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| sourceSecurityGroups | java.util.List | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`ec2SshKey\`Required +##### \`ec2SshKey\`Required \`\`\`java public java.lang.String getEc2SshKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -55866,13 +52849,13 @@ public java.lang.String getEc2SshKey(); --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`java public java.util.List getSourceSecurityGroups(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -55880,11 +52863,11 @@ public java.util.List getSourceSecurityGroups(); --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnCluster.ResourcesVpcConfigProperty; @@ -55895,22 +52878,22 @@ ResourcesVpcConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`subnetIds\`](#softwareamazonawscdkservicesekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | java.util.List<\`java.lang.String\`> | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`securityGroupIds\`](#softwareamazonawscdkservicesekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | java.util.List<\`java.lang.String\`> | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| subnetIds | java.util.List | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| securityGroupIds | java.util.List | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`subnetIds\`Required +##### \`subnetIds\`Required \`\`\`java public java.util.List getSubnetIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -55918,13 +52901,13 @@ public java.util.List getSubnetIds(); --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`java public java.util.List getSecurityGroupIds(); \`\`\` -- *Type:* java.util.List<\`java.lang.String\`> +- *Type:* java.util.List \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -55932,11 +52915,11 @@ public java.util.List getSecurityGroupIds(); --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.ScalingConfigProperty; @@ -55948,23 +52931,23 @@ ScalingConfigProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`desiredSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`maxSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`minSize\`](#softwareamazonawscdkservicesekscfnnodegroupscalingconfigpropertypropertyminsize) | \`java.lang.Number\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| desiredSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| maxSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| minSize | java.lang.Number | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`java public java.lang.Number getDesiredSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -55972,13 +52955,13 @@ public java.lang.Number getDesiredSize(); --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`java public java.lang.Number getMaxSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -55986,13 +52969,13 @@ public java.lang.Number getMaxSize(); --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`java public java.lang.Number getMinSize(); \`\`\` -- *Type:* \`java.lang.Number\` +- *Type:* java.lang.Number \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -56000,11 +52983,11 @@ public java.lang.Number getMinSize(); --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.Selector; @@ -56015,22 +52998,22 @@ Selector.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkserviceseksselectorpropertynamespace)* | \`java.lang.String\` | The Kubernetes namespace that the selector should match. | -| [\`labels\`](#softwareamazonawscdkserviceseksselectorpropertylabels) | java.util.Map | The Kubernetes labels that the selector should match. | +| namespace | java.lang.String | The Kubernetes namespace that the selector should match. | +| labels | java.util.Map | The Kubernetes labels that the selector should match. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The Kubernetes namespace that the selector should match. @@ -56038,13 +53021,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.util.Map getLabels(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -56053,11 +53036,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnFargateProfile.SelectorProperty; @@ -56070,22 +53053,22 @@ SelectorProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkservicesekscfnfargateprofileselectorpropertypropertynamespace)* | \`java.lang.String\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`labels\`](#softwareamazonawscdkservicesekscfnfargateprofileselectorpropertypropertylabels) | [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| namespace | java.lang.String | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| labels | software.amazon.awscdk.core.IResolvable OR java.util.List | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -56093,13 +53076,13 @@ public java.lang.String getNamespace(); --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`java public java.lang.Object getLabels(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable) OR java.util.List<[\`software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty\`](#software.amazon.awscdk.services.eks.CfnFargateProfile.LabelProperty) OR [\`software.amazon.awscdk.core.IResolvable\`](#software.amazon.awscdk.core.IResolvable)> +- *Type:* software.amazon.awscdk.core.IResolvable OR java.util.List \`CfnFargateProfile.SelectorProperty.Labels\`. @@ -56107,11 +53090,11 @@ public java.lang.Object getLabels(); --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccountOptions; @@ -56122,46 +53105,46 @@ ServiceAccountOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountoptionspropertyname) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountoptionspropertynamespace) | \`java.lang.String\` | The namespace of the service account. | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceAccountProps; @@ -56173,59 +53156,59 @@ ServiceAccountProps.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertyname) | \`java.lang.String\` | The name of the service account. | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertynamespace) | \`java.lang.String\` | The namespace of the service account. | -| [\`cluster\`](#softwareamazonawscdkserviceseksserviceaccountpropspropertycluster)* | [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) | The cluster to apply the patch to. | +| name | java.lang.String | The name of the service account. | +| namespace | java.lang.String | The namespace of the service account. | +| cluster | software.amazon.awscdk.services.eks.ICluster | The cluster to apply the patch to. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`java public java.lang.String getName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`java public ICluster getCluster(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Type:* software.amazon.awscdk.services.eks.ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.ServiceLoadBalancerAddressOptions; @@ -56236,46 +53219,46 @@ ServiceLoadBalancerAddressOptions.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#softwareamazonawscdkserviceseksserviceloadbalanceraddressoptionspropertynamespace) | \`java.lang.String\` | The namespace the service belongs to. | -| [\`timeout\`](#softwareamazonawscdkserviceseksserviceloadbalanceraddressoptionspropertytimeout) | [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) | Timeout for waiting on the load balancer address. | +| namespace | java.lang.String | The namespace the service belongs to. | +| timeout | software.amazon.awscdk.core.Duration | Timeout for waiting on the load balancer address. | --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`java public java.lang.String getNamespace(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* 'default' The namespace the service belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`java public Duration getTimeout(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Duration\`](#software.amazon.awscdk.core.Duration) +- *Type:* software.amazon.awscdk.core.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`java import software.amazon.awscdk.services.eks.CfnNodegroup.TaintProperty; @@ -56287,23 +53270,23 @@ TaintProperty.builder() .build(); \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`effect\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertyeffect) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`key\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertykey) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`value\`](#softwareamazonawscdkservicesekscfnnodegrouptaintpropertypropertyvalue) | \`java.lang.String\` | \`CfnNodegroup.TaintProperty.Value\`. | +| effect | java.lang.String | \`CfnNodegroup.TaintProperty.Effect\`. | +| key | java.lang.String | \`CfnNodegroup.TaintProperty.Key\`. | +| value | java.lang.String | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`effect\`Optional +##### \`effect\`Optional \`\`\`java public java.lang.String getEffect(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Effect\`. @@ -56311,13 +53294,13 @@ public java.lang.String getEffect(); --- -##### \`key\`Optional +##### \`key\`Optional \`\`\`java public java.lang.String getKey(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Key\`. @@ -56325,13 +53308,13 @@ public java.lang.String getKey(); --- -##### \`value\`Optional +##### \`value\`Optional \`\`\`java public java.lang.String getValue(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`CfnNodegroup.TaintProperty.Value\`. @@ -56339,15 +53322,15 @@ public java.lang.String getValue(); --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`software.amazon.awscdk.services.ec2.IMachineImage\`](#software.amazon.awscdk.services.ec2.IMachineImage) +- *Implements:* software.amazon.awscdk.services.ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`java import software.amazon.awscdk.services.eks.EksOptimizedImage; @@ -56361,83 +53344,83 @@ EksOptimizedImage.Builder.create() | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpuArch\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparametercpuarch) | [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetesVersion\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparameterkubernetesversion) | \`java.lang.String\` | The Kubernetes version to use. | -| [\`nodeType\`](#softwareamazonawscdkservicesekseksoptimizedimagepropsparameternodetype) | [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpuArch | software.amazon.awscdk.services.eks.CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetesVersion | java.lang.String | The Kubernetes version to use. | +| nodeType | software.amazon.awscdk.services.eks.NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpuArch\`Optional +##### \`cpuArch\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.CpuArch\`](#software.amazon.awscdk.services.eks.CpuArch) +- *Type:* software.amazon.awscdk.services.eks.CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetesVersion\`Optional +##### \`kubernetesVersion\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String - *Default:* The latest version The Kubernetes version to use. --- -##### \`nodeType\`Optional +##### \`nodeType\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.NodeType\`](#software.amazon.awscdk.services.eks.NodeType) +- *Type:* software.amazon.awscdk.services.eks.NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`getImage\`](#softwareamazonawscdkservicesekseksoptimizedimagegetimage) | Return the correct image. | +| getImage | Return the correct image. | --- -##### \`getImage\` +##### \`getImage\` \`\`\`java public getImage(Construct scope) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`onlyFrom\`](#softwareamazonawscdkserviceseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| onlyFrom | Restrict public access to specific CIDR blocks. | --- -##### \`onlyFrom\` +##### \`onlyFrom\` \`\`\`java public onlyFrom(java.lang.String cidr) \`\`\` -###### \`cidr\`Required +###### \`cidr\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String CIDR blocks. @@ -56445,19 +53428,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PRIVATE\`](#softwareamazonawscdkserviceseksendpointaccesspropertyprivate)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`PUBLIC\`](#softwareamazonawscdkserviceseksendpointaccesspropertypublic)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PUBLIC_AND_PRIVATE\`](#softwareamazonawscdkserviceseksendpointaccesspropertypublicandprivate)* | [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| PRIVATE | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| PUBLIC | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PUBLIC_AND_PRIVATE | software.amazon.awscdk.services.eks.EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`PRIVATE\` +##### \`PRIVATE\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +\`\`\`java +public EndpointAccess getPrivate(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -56465,9 +53452,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`PUBLIC\` +##### \`PUBLIC\`Required + +\`\`\`java +public EndpointAccess getPublic(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -56475,9 +53466,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PUBLIC_AND_PRIVATE\` +##### \`PUBLIC_AND_PRIVATE\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.EndpointAccess\`](#software.amazon.awscdk.services.eks.EndpointAccess) +\`\`\`java +public EndpointAccess getPublicAndPrivate(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -56485,20 +53480,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`of\`](#softwareamazonawscdkservicesekskubernetesversionof) | Custom cluster version. | +| of | Custom cluster version. | --- -##### \`of\` +##### \`of\` \`\`\`java import software.amazon.awscdk.services.eks.KubernetesVersion; @@ -56506,251 +53501,275 @@ import software.amazon.awscdk.services.eks.KubernetesVersion; KubernetesVersion.of(java.lang.String version) \`\`\` -###### \`version\`Required +###### \`version\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#softwareamazonawscdkservicesekskubernetesversionpropertyversion)* | \`java.lang.String\` | cluster version number. | +| version | java.lang.String | cluster version number. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`java public java.lang.String getVersion(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V1_14\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv114)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V1_15\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv115)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V1_16\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv116)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V1_17\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv117)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V1_18\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv118)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V1_19\`](#softwareamazonawscdkservicesekskubernetesversionpropertyv119)* | [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) | Kubernetes version 1.19. | +| V1_14 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.14. | +| V1_15 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.15. | +| V1_16 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.16. | +| V1_17 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.17. | +| V1_18 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.18. | +| V1_19 | software.amazon.awscdk.services.eks.KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V1_14\` +##### \`V1_14\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +\`\`\`java +public KubernetesVersion getV114(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.14. --- -##### \`V1_15\` +##### \`V1_15\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +\`\`\`java +public KubernetesVersion getV115(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.15. --- -##### \`V1_16\` +##### \`V1_16\`Required + +\`\`\`java +public KubernetesVersion getV116(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.16. --- -##### \`V1_17\` +##### \`V1_17\`Required + +\`\`\`java +public KubernetesVersion getV117(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.17. --- -##### \`V1_18\` +##### \`V1_18\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +\`\`\`java +public KubernetesVersion getV118(); +\`\`\` + +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.18. --- -##### \`V1_19\` +##### \`V1_19\`Required + +\`\`\`java +public KubernetesVersion getV119(); +\`\`\` -- *Type:* [\`software.amazon.awscdk.services.eks.KubernetesVersion\`](#software.amazon.awscdk.services.eks.KubernetesVersion) +- *Type:* software.amazon.awscdk.services.eks.KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`software.amazon.awscdk.core.IResource\`](#software.amazon.awscdk.core.IResource), [\`software.amazon.awscdk.services.ec2.IConnectable\`](#software.amazon.awscdk.services.ec2.IConnectable) +- *Extends:* software.amazon.awscdk.core.IResource, software.amazon.awscdk.services.ec2.IConnectable -- *Implemented By:* [\`software.amazon.awscdk.services.eks.Cluster\`](#software.amazon.awscdk.services.eks.Cluster), [\`software.amazon.awscdk.services.eks.FargateCluster\`](#software.amazon.awscdk.services.eks.FargateCluster), [\`software.amazon.awscdk.services.eks.ICluster\`](#software.amazon.awscdk.services.eks.ICluster) +- *Implemented By:* software.amazon.awscdk.services.eks.Cluster, software.amazon.awscdk.services.eks.FargateCluster, software.amazon.awscdk.services.eks.ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addCdk8sChart\`](#softwareamazonawscdkserviceseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addHelmChart\`](#softwareamazonawscdkserviceseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#softwareamazonawscdkserviceseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addServiceAccount\`](#softwareamazonawscdkserviceseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`java public addCdk8sChart(java.lang.String id, Construct chart) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`software.constructs.Construct\`](#software.constructs.Construct) +- *Type:* software.constructs.Construct the cdk8s chart. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`java public addHelmChart(java.lang.String id, HelmChartOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`software.amazon.awscdk.services.eks.HelmChartOptions\`](#software.amazon.awscdk.services.eks.HelmChartOptions) +- *Type:* software.amazon.awscdk.services.eks.HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`java public addManifest(java.lang.String id, java.util.Map manifest) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* java.util.Map +- *Type:* java.util.Map a list of Kubernetes resource specifications. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`java public addServiceAccount(java.lang.String id) public addServiceAccount(java.lang.String id, ServiceAccountOptions options) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String logical id of service account. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.eks.ServiceAccountOptions\`](#software.amazon.awscdk.services.eks.ServiceAccountOptions) +- *Type:* software.amazon.awscdk.services.eks.ServiceAccountOptions service account options. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkserviceseksiclusterpropertynode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#softwareamazonawscdkserviceseksiclusterpropertyenv)* | [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkserviceseksiclusterpropertystack)* | [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) | The stack in which this resource is defined. | -| [\`connections\`](#softwareamazonawscdkserviceseksiclusterpropertyconnections)* | [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) | *No description.* | -| [\`clusterArn\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterarn)* | \`java.lang.String\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`clusterCertificateAuthorityData\`](#softwareamazonawscdkserviceseksiclusterpropertyclustercertificateauthoritydata)* | \`java.lang.String\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`java.lang.String\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#softwareamazonawscdkserviceseksiclusterpropertyclusterendpoint)* | \`java.lang.String\` | The API Server endpoint URL. | -| [\`clusterName\`](#softwareamazonawscdkserviceseksiclusterpropertyclustername)* | \`java.lang.String\` | The physical name of the Cluster. | -| [\`clusterSecurityGroup\`](#softwareamazonawscdkserviceseksiclusterpropertyclustersecuritygroup)* | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#softwareamazonawscdkserviceseksiclusterpropertyclustersecuritygroupid)* | \`java.lang.String\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`openIdConnectProvider\`](#softwareamazonawscdkserviceseksiclusterpropertyopenidconnectprovider)* | [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`prune\`](#softwareamazonawscdkserviceseksiclusterpropertyprune)* | \`java.lang.Boolean\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`vpc\`](#softwareamazonawscdkserviceseksiclusterpropertyvpc)* | [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`kubectlEnvironment\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlenvironment) | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#softwareamazonawscdkserviceseksiclusterpropertykubectllayer) | [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`kubectlMemory\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlmemory) | [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlprivatesubnets) | java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlrole) | [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#softwareamazonawscdkserviceseksiclusterpropertykubectlsecuritygroup) | [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| node | software.amazon.awscdk.core.ConstructNode | The construct tree node for this construct. | +| env | software.amazon.awscdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.core.Stack | The stack in which this resource is defined. | +| connections | software.amazon.awscdk.services.ec2.Connections | *No description.* | +| clusterArn | java.lang.String | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| clusterCertificateAuthorityData | java.lang.String | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | java.lang.String | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | java.lang.String | The API Server endpoint URL. | +| clusterName | java.lang.String | The physical name of the Cluster. | +| clusterSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | java.lang.String | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| openIdConnectProvider | software.amazon.awscdk.services.iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| prune | java.lang.Boolean | Indicates whether Kubernetes resources can be automatically pruned. | +| vpc | software.amazon.awscdk.services.ec2.IVpc | The VPC in which this Cluster was created. | +| kubectlEnvironment | java.util.Map | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | software.amazon.awscdk.services.lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| kubectlMemory | software.amazon.awscdk.core.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnets | java.util.List | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | software.amazon.awscdk.services.iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | software.amazon.awscdk.services.ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`java public ConstructNode getNode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) +- *Type:* software.amazon.awscdk.core.ResourceEnvironment The environment this resource belongs to. @@ -56758,131 +53777,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) +- *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`java public Connections getConnections(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.Connections\`](#software.amazon.awscdk.services.ec2.Connections) +- *Type:* software.amazon.awscdk.services.ec2.Connections --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`java public java.lang.String getClusterArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`java public java.lang.String getClusterCertificateAuthorityData(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`java public java.lang.String getClusterEncryptionConfigKeyArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`java public java.lang.String getClusterEndpoint(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The API Server endpoint URL. --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`java public java.lang.String getClusterName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The physical name of the Cluster. --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`java public ISecurityGroup getClusterSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`java public java.lang.String getClusterSecurityGroupId(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`java public IOpenIdConnectProvider getOpenIdConnectProvider(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IOpenIdConnectProvider\`](#software.amazon.awscdk.services.iam.IOpenIdConnectProvider) +- *Type:* software.amazon.awscdk.services.iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`java public java.lang.Boolean getPrune(); \`\`\` -- *Type:* \`java.lang.Boolean\` +- *Type:* java.lang.Boolean Indicates whether Kubernetes resources can be automatically pruned. @@ -56890,37 +53909,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`java public IVpc getVpc(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.IVpc\`](#software.amazon.awscdk.services.ec2.IVpc) +- *Type:* software.amazon.awscdk.services.ec2.IVpc The VPC in which this Cluster was created. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`java public java.util.Map getKubectlEnvironment(); \`\`\` -- *Type:* java.util.Map +- *Type:* java.util.Map Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`java public ILayerVersion getKubectlLayer(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.lambda.ILayerVersion\`](#software.amazon.awscdk.services.lambda.ILayerVersion) +- *Type:* software.amazon.awscdk.services.lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -56928,25 +53947,25 @@ If not defined, a default layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`java public Size getKubectlMemory(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Size\`](#software.amazon.awscdk.core.Size) +- *Type:* software.amazon.awscdk.core.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`java public java.util.List getKubectlPrivateSubnets(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.services.ec2.ISubnet\`](#software.amazon.awscdk.services.ec2.ISubnet)> +- *Type:* java.util.List Subnets to host the \`kubectl\` compute resources. @@ -56954,13 +53973,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`java public IRole getKubectlRole(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.iam.IRole\`](#software.amazon.awscdk.services.iam.IRole) +- *Type:* software.amazon.awscdk.services.iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -56968,13 +53987,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`java public ISecurityGroup getKubectlSecurityGroup(); \`\`\` -- *Type:* [\`software.amazon.awscdk.services.ec2.ISecurityGroup\`](#software.amazon.awscdk.services.ec2.ISecurityGroup) +- *Type:* software.amazon.awscdk.services.ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -56982,45 +54001,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`software.amazon.awscdk.core.IResource\`](#software.amazon.awscdk.core.IResource) +- *Extends:* software.amazon.awscdk.core.IResource -- *Implemented By:* [\`software.amazon.awscdk.services.eks.Nodegroup\`](#software.amazon.awscdk.services.eks.Nodegroup), [\`software.amazon.awscdk.services.eks.INodegroup\`](#software.amazon.awscdk.services.eks.INodegroup) +- *Implemented By:* software.amazon.awscdk.services.eks.Nodegroup, software.amazon.awscdk.services.eks.INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkserviceseksinodegrouppropertynode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#softwareamazonawscdkserviceseksinodegrouppropertyenv)* | [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkserviceseksinodegrouppropertystack)* | [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) | The stack in which this resource is defined. | -| [\`nodegroupName\`](#softwareamazonawscdkserviceseksinodegrouppropertynodegroupname)* | \`java.lang.String\` | Name of the nodegroup. | +| node | software.amazon.awscdk.core.ConstructNode | The construct tree node for this construct. | +| env | software.amazon.awscdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.core.Stack | The stack in which this resource is defined. | +| nodegroupName | java.lang.String | Name of the nodegroup. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`java public ConstructNode getNode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) +- *Type:* software.amazon.awscdk.core.ResourceEnvironment The environment this resource belongs to. @@ -57028,164 +54047,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) +- *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`java public java.lang.String getNodegroupName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#softwareamazonawscdkservicesekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#softwareamazonawscdkservicesekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#softwareamazonawscdkservicesekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#softwareamazonawscdkservicesekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#softwareamazonawscdkservicesekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#softwareamazonawscdkservicesekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#softwareamazonawscdkserviceseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#softwareamazonawscdkserviceseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#softwareamazonawscdkserviceseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#softwareamazonawscdkserviceseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#softwareamazonawscdkserviceseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -57193,164 +54212,5173 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#softwareamazonawscdkserviceseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#softwareamazonawscdkserviceseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#softwareamazonawscdkserviceseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` + +Inferentia instances. + +--- + + +### PatchType + +| **Name** | **Description** | +| --- | --- | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | + +--- + +Values for \`kubectl patch\` --type argument. + +#### \`JSON\` + +JSON Patch, RFC 6902. + +--- + + +#### \`MERGE\` + +JSON Merge patch. + +--- + + +#### \`STRATEGIC\` + +Strategic merge patch. + +--- + +" +`; + +exports[`package installation does not run lifecycle hooks 1`] = ` +"# construct-library + +This is a test project to make sure the \`jsii-docgen\` cli property renders API documentation +for construct libraries. +# API Reference + +## Constructs + +### GreeterBucket + +#### Initializers + +\`\`\`typescript +import { GreeterBucket } from 'construct-library' + +new GreeterBucket(scope: Construct, id: string, props?: BucketProps) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | @aws-cdk/aws-s3.BucketProps | *No description.* | + +--- + +##### \`scope\`Required + +- *Type:* constructs.Construct + +--- + +##### \`id\`Required + +- *Type:* string + +--- + +##### \`props\`Optional + +- *Type:* @aws-cdk/aws-s3.BucketProps + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| greet | *No description.* | + +--- + +##### \`greet\` + +\`\`\`typescript +public greet() +\`\`\` + + + + + + + +" +`; + +exports[`python for package 1`] = ` +Object { + "apiReference": Object { + "classes": Array [ + Object { + "constants": Array [], + "displayName": "AuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html", + ], + "summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.", + }, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken", + "id": "@aws-cdk/aws-ecr.AuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "grant_read", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.AuthorizationToken.grant_read( + grantee: IGrantable +)", + }, + ], + }, + Object { + "constants": Array [], + "displayName": "PublicGalleryAuthorizationToken", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth", + ], + "summary": "Authorization token to access the global public ECR Gallery via Docker CLI.", + }, + "fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken", + "id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken", + "initializer": undefined, + "instanceMethods": Array [], + "interfaces": Array [], + "properties": Array [], + "staticMethods": Array [ + Object { + "displayName": "grant_read", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read", + "id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read.parameter.grantee", + "id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( + grantee: IGrantable +)", + }, + ], + }, + ], + "constructs": Array [ + Object { + "constants": Array [ + Object { + "const": true, + "default": undefined, + "displayName": "CFN_RESOURCE_TYPE_NAME", + "docs": Object { + "summary": "The CloudFormation resource type name for this resource class.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.CFN_RESOURCE_TYPE_NAME", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.CFN_RESOURCE_TYPE_NAME", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "CFN_RESOURCE_TYPE_NAME: str", + }, + ], + "displayName": "CfnPublicRepository", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "A CloudFormation \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "aws_cdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepository( + scope: Construct, + id: str, + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "aws_cdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def inspect( + inspector: TreeInspector +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IInspectable", + "fqn": "aws_cdk.core.IInspectable", + "id": "@aws-cdk/core.IInspectable", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "attr_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.attr_arn", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.attrArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "attr_arn: str", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.tags", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagManager", + "fqn": "aws_cdk.core.TagManager", + "id": "@aws-cdk/core.TagManager", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "tags: TagManager", + }, + Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryCatalogData", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_catalog_data: typing.Any", + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryPolicyText", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_policy_text: typing.Any", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_name", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + ], + "staticMethods": Array [], + }, + Object { + "constants": Array [ + Object { + "const": true, + "default": undefined, + "displayName": "CFN_RESOURCE_TYPE_NAME", + "docs": Object { + "summary": "The CloudFormation resource type name for this resource class.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.CFN_RESOURCE_TYPE_NAME", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.CFN_RESOURCE_TYPE_NAME", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "CFN_RESOURCE_TYPE_NAME: str", + }, + ], + "displayName": "CfnRegistryPolicy", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html", + ], + "summary": "A CloudFormation \`AWS::ECR::RegistryPolicy\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "aws_cdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext", + ], + "summary": "\`AWS::ECR::RegistryPolicy.PolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.policy_text", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.policyText", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicy( + scope: Construct, + id: str, + policy_text: typing.Any +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.inspect", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "aws_cdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def inspect( + inspector: TreeInspector +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IInspectable", + "fqn": "aws_cdk.core.IInspectable", + "id": "@aws-cdk/core.IInspectable", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "attr_registry_id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.attr_registry_id", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.attrRegistryId", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "attr_registry_id: str", + }, + Object { + "default": undefined, + "displayName": "policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext", + ], + "summary": "\`AWS::ECR::RegistryPolicy.PolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.policy_text", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.policyText", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "policy_text: typing.Any", + }, + ], + "staticMethods": Array [], + }, + Object { + "constants": Array [ + Object { + "const": true, + "default": undefined, + "displayName": "CFN_RESOURCE_TYPE_NAME", + "docs": Object { + "summary": "The CloudFormation resource type name for this resource class.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.CFN_RESOURCE_TYPE_NAME", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.CFN_RESOURCE_TYPE_NAME", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "CFN_RESOURCE_TYPE_NAME: str", + }, + ], + "displayName": "CfnReplicationConfiguration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html", + ], + "summary": "A CloudFormation \`AWS::ECR::ReplicationConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "aws_cdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "replication_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration", + ], + "summary": "\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.replication_configuration", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.replicationConfiguration", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ReplicationConfigurationProperty", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration( + scope: Construct, + id: str, + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.inspect", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "aws_cdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def inspect( + inspector: TreeInspector +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IInspectable", + "fqn": "aws_cdk.core.IInspectable", + "id": "@aws-cdk/core.IInspectable", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "attr_registry_id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.attr_registry_id", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.attrRegistryId", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "attr_registry_id: str", + }, + Object { + "default": undefined, + "displayName": "replication_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration", + ], + "summary": "\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.replication_configuration", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.replicationConfiguration", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ReplicationConfigurationProperty", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]", + }, + ], + "staticMethods": Array [], + }, + Object { + "constants": Array [ + Object { + "const": true, + "default": undefined, + "displayName": "CFN_RESOURCE_TYPE_NAME", + "docs": Object { + "summary": "The CloudFormation resource type name for this resource class.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.CFN_RESOURCE_TYPE_NAME", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.CFN_RESOURCE_TYPE_NAME", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "CFN_RESOURCE_TYPE_NAME: str", + }, + ], + "displayName": "CfnRepository", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html", + ], + "summary": "A CloudFormation \`AWS::ECR::Repository\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository", + "id": "@aws-cdk/aws-ecr.CfnRepository", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "aws_cdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "encryption_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration", + ], + "summary": "\`AWS::ECR::Repository.EncryptionConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.encryption_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.encryptionConfiguration", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "image_scanning_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration", + ], + "summary": "\`AWS::ECR::Repository.ImageScanningConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.image_scanning_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.imageScanningConfiguration", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "image_tag_mutability", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability", + ], + "summary": "\`AWS::ECR::Repository.ImageTagMutability\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.image_tag_mutability", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.imageTagMutability", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "lifecycle_policy", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy", + ], + "summary": "\`AWS::ECR::Repository.LifecyclePolicy\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.lifecycle_policy", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.lifecyclePolicy", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "LifecyclePolicyProperty", + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname", + ], + "summary": "\`AWS::ECR::Repository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::Repository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags", + ], + "summary": "\`AWS::ECR::Repository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.tags", + "id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepository( + scope: Construct, + id: str, + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.inspect", + "id": "@aws-cdk/aws-ecr.CfnRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "aws_cdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def inspect( + inspector: TreeInspector +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IInspectable", + "fqn": "aws_cdk.core.IInspectable", + "id": "@aws-cdk/core.IInspectable", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "attr_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.attr_arn", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.attrArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "attr_arn: str", + }, + Object { + "default": undefined, + "displayName": "attr_repository_uri", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.attr_repository_uri", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.attrRepositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "attr_repository_uri: str", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags", + ], + "summary": "\`AWS::ECR::Repository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.tags", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.tags", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagManager", + "fqn": "aws_cdk.core.TagManager", + "id": "@aws-cdk/core.TagManager", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "tags: TagManager", + }, + Object { + "default": undefined, + "displayName": "encryption_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration", + ], + "summary": "\`AWS::ECR::Repository.EncryptionConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.encryption_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.encryptionConfiguration", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "encryption_configuration: typing.Any", + }, + Object { + "default": undefined, + "displayName": "image_scanning_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration", + ], + "summary": "\`AWS::ECR::Repository.ImageScanningConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.image_scanning_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.imageScanningConfiguration", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "image_scanning_configuration: typing.Any", + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::Repository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.repositoryPolicyText", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_policy_text: typing.Any", + }, + Object { + "default": undefined, + "displayName": "image_tag_mutability", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability", + ], + "summary": "\`AWS::ECR::Repository.ImageTagMutability\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.image_tag_mutability", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.imageTagMutability", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "image_tag_mutability: str", + }, + Object { + "default": undefined, + "displayName": "lifecycle_policy", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy", + ], + "summary": "\`AWS::ECR::Repository.LifecyclePolicy\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.lifecycle_policy", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.lifecyclePolicy", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "LifecyclePolicyProperty", + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty]", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname", + ], + "summary": "\`AWS::ECR::Repository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.property.repository_name", + "id": "@aws-cdk/aws-ecr.CfnRepository.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + ], + "staticMethods": Array [], + }, + Object { + "constants": Array [], + "displayName": "Repository", + "docs": Object { + "summary": "Define an ECR repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.Repository.Initializer", + "id": "@aws-cdk/aws-ecr.Repository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "constructs.Construct", + "id": "constructs.Construct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "false", + "displayName": "image_scan_on_push", + "docs": Object { + "summary": "Enable the scan on push when creating the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.image_scan_on_push", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.imageScanOnPush", + "optional": true, + "type": Object { + "formattingPattern": "bool", + }, + }, + Object { + "default": "TagMutability.MUTABLE", + "displayName": "image_tag_mutability", + "docs": Object { + "remarks": "If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten.", + "summary": "The tag mutability setting for the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.image_tag_mutability", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.imageTagMutability", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagMutability", + "fqn": "aws_cdk.aws_ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "The default registry is assumed.", + "displayName": "lifecycle_registry_id", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html", + ], + "summary": "The AWS account ID associated with the registry that contains the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.lifecycle_registry_id", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.lifecycleRegistryId", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "No life cycle rules", + "displayName": "lifecycle_rules", + "docs": Object { + "summary": "Life cycle rules to apply to this registry.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.lifecycle_rules", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.lifecycleRules", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "LifecycleRule", + "fqn": "aws_cdk.aws_ecr.LifecycleRule", + "id": "@aws-cdk/aws-ecr.LifecycleRule", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + Object { + "default": "RemovalPolicy.Retain", + "displayName": "removal_policy", + "docs": Object { + "summary": "Determine what happens to the repository when the resource/stack is deleted.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.removal_policy", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.removalPolicy", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "RemovalPolicy", + "fqn": "aws_cdk.core.RemovalPolicy", + "id": "@aws-cdk/core.RemovalPolicy", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "Automatically generated name.", + "displayName": "repository_name", + "docs": Object { + "summary": "Name for this repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository( + scope: Construct, + id: str, + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "add_lifecycle_rule", + "docs": Object { + "remarks": "Life cycle rules automatically expire images from the repository that match +certain conditions.", + "summary": "Add a life cycle rule to the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule", + "parameters": Array [ + Object { + "default": "No description", + "displayName": "description", + "docs": Object { + "summary": "Describes the purpose of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.description", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "max_image_age", + "docs": Object { + "remarks": "Specify exactly one of maxImageCount and maxImageAge.", + "summary": "The maximum age of images to retain. The value must represent a number of days.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.max_image_age", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.maxImageAge", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Duration", + "fqn": "aws_cdk.core.Duration", + "id": "@aws-cdk/core.Duration", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "max_image_count", + "docs": Object { + "remarks": "Specify exactly one of maxImageCount and maxImageAge.", + "summary": "The maximum number of images to retain.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.max_image_count", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.maxImageCount", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[int, float]", + }, + }, + Object { + "default": "Automatically assigned", + "displayName": "rule_priority", + "docs": Object { + "remarks": "All rules must have a unique priority, where lower numbers have +higher precedence. The first rule that matches is applied to an image. + +There can only be one rule with a tagStatus of Any, and it must have +the highest rulePriority. + +All rules without a specified priority will have incrementing priorities +automatically assigned to them, higher than any rules that DO have priorities.", + "summary": "Controls the order in which rules are evaluated (low to high).", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.rule_priority", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.rulePriority", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[int, float]", + }, + }, + Object { + "default": undefined, + "displayName": "tag_prefix_list", + "docs": Object { + "remarks": "Only if tagStatus == TagStatus.Tagged", + "summary": "Select images that have ALL the given prefixes in their tag.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.tag_prefix_list", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.tagPrefixList", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + }, + Object { + "default": "TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise", + "displayName": "tag_status", + "docs": Object { + "remarks": "Only one rule is allowed to select untagged images, and it must +have the highest rulePriority.", + "summary": "Select images based on tags.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.tag_status", + "id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.tagStatus", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagStatus", + "fqn": "aws_cdk.aws_ecr.TagStatus", + "id": "@aws-cdk/aws-ecr.TagStatus", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def add_lifecycle_rule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +)", + }, + Object { + "displayName": "add_to_resource_policy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.add_to_resource_policy", + "id": "@aws-cdk/aws-ecr.Repository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.add_to_resource_policy.parameter.statement", + "id": "@aws-cdk/aws-ecr.Repository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "aws_cdk.aws_iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def add_to_resource_policy( + statement: PolicyStatement +)", + }, + ], + "interfaces": Array [], + "properties": Array [ + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.property.repository_arn", + "id": "@aws-cdk/aws-ecr.Repository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_arn: str", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.property.repository_name", + "id": "@aws-cdk/aws-ecr.Repository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + ], + "staticMethods": Array [ + Object { + "displayName": "arn_for_local_repository", + "docs": Object { + "summary": "Returns an ECR ARN for a repository that resides in the same account/region as the current stack.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository", + "id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.scope", + "id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IConstruct", + "fqn": "constructs.IConstruct", + "id": "constructs.IConstruct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "account", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.account", + "id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.account", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.arn_for_local_repository( + repository_name: str, + scope: IConstruct, + account: str = None +)", + }, + Object { + "displayName": "from_repository_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.scope", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "constructs.Construct", + "id": "constructs.Construct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.id", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.repository_arn", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_arn( + scope: Construct, + id: str, + repository_arn: str +)", + }, + Object { + "displayName": "from_repository_attributes", + "docs": Object { + "summary": "Import a repository.", + }, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.scope", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "constructs.Construct", + "id": "constructs.Construct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.id", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.repository_arn", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_attributes( + scope: Construct, + id: str, + repository_arn: str, + repository_name: str +)", + }, + Object { + "displayName": "from_repository_name", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_name", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.scope", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "constructs.Construct", + "id": "constructs.Construct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.id", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_name( + scope: Construct, + id: str, + repository_name: str +)", + }, + ], + }, + Object { + "constants": Array [], + "displayName": "RepositoryBase", + "docs": Object { + "remarks": "Reused between imported repositories and owned repositories.", + "summary": "Base class for ECR repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "initializer": Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "constructs.Construct", + "id": "constructs.Construct", + "packageName": "constructs", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- the resource is in the same account as the stack it belongs to", + "displayName": "account", + "docs": Object { + "summary": "The AWS account ID this resource belongs to.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.account", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.account", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- take environment from \`account\`, \`region\` parameters, or use Stack environment.", + "displayName": "environment_from_arn", + "docs": Object { + "remarks": "The ARN is parsed and the account and region are taken from the ARN. +This should be used for imported resources. + +Cannot be supplied together with either \`account\` or \`region\`.", + "summary": "ARN to deduce region and account from.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.environment_from_arn", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.environmentFromArn", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- The physical name will be allocated by CloudFormation at deployment time", + "displayName": "physical_name", + "docs": Object { + "remarks": "- \`undefined\` implies that a physical name will be allocated by + CloudFormation during deployment. +- a concrete value implies a specific physical name +- \`PhysicalName.GENERATE_IF_NEEDED\` is a marker that indicates that a physical will only be generated + by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.", + "summary": "The value passed in by users to the physical name prop of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.physical_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.physicalName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- the resource is in the same region as the stack it belongs to", + "displayName": "region", + "docs": Object { + "summary": "The AWS region this resource belongs to.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.region", + "id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.region", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryBase( + scope: Construct, + id: str, + account: str = None, + environment_from_arn: str = None, + physical_name: str = None, + region: str = None +)", + }, + "instanceMethods": Array [ + Object { + "displayName": "add_to_resource_policy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.add_to_resource_policy", + "id": "@aws-cdk/aws-ecr.RepositoryBase.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.add_to_resource_policy.parameter.statement", + "id": "@aws-cdk/aws-ecr.RepositoryBase.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "aws_cdk.aws_iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def add_to_resource_policy( + statement: PolicyStatement +)", + }, + Object { + "displayName": "grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant.parameter.grantee", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "actions", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant.parameter.actions", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def grant( + grantee: IGrantable, + actions: str +)", + }, + Object { + "displayName": "grant_pull", + "docs": Object { + "summary": "Grant the given identity permissions to use the images in this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull.parameter.grantee", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull( + grantee: IGrantable +)", + }, + Object { + "displayName": "grant_pull_push", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull_push", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull_push.parameter.grantee", + "id": "@aws-cdk/aws-ecr.RepositoryBase.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull_push( + grantee: IGrantable +)", + }, + Object { + "displayName": "on_cloud_trail_event", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.id", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.description", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.target", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_cloud_trail_image_pushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.id", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.description", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.target", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch changes to all tags", + "displayName": "image_tag", + "docs": Object { + "summary": "Only watch changes to this image tag.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.image_tag", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.imageTag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +)", + }, + Object { + "displayName": "on_event", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.id", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.description", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.target", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_image_scan_completed", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.id", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.description", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.target", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch the changes to the repository with all image tags", + "displayName": "image_tags", + "docs": Object { + "remarks": "Leave it undefined to watch the full repository.", + "summary": "Only watch changes to the image tags spedified.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.image_tags", + "id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.imageTags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + }, + ], + "usage": "def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +)", + }, + Object { + "displayName": "repository_uri_for_digest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URL of the repository. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_digest", + "id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "digest", + "docs": Object { + "summary": "Optional image digest.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_digest.parameter.digest", + "id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_digest( + digest: str = None +)", + }, + Object { + "displayName": "repository_uri_for_tag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URL of the repository. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_tag", + "id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "tag", + "docs": Object { + "summary": "Optional image tag.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_tag.parameter.tag", + "id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_tag( + tag: str = None +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IRepository", + "fqn": "aws_cdk.aws_ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_arn", + "id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_arn: str", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_name", + "id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_uri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_uri", + "id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_uri: str", + }, + ], + "staticMethods": Array [], + }, + ], + "enums": Array [ + Object { + "displayName": "TagMutability", + "docs": Object { + "summary": "The tag mutability setting for your repository.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "members": Array [ + Object { + "displayName": "MUTABLE", + "docs": Object { + "summary": "allow image tags to be overwritten.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability.MUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + }, + Object { + "displayName": "IMMUTABLE", + "docs": Object { + "summary": "all image tags within the repository will be immutable which will prevent them from being overwritten.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability.IMMUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + }, + ], + }, + Object { + "displayName": "TagStatus", + "docs": Object { + "summary": "Select images based on tags.", + }, + "fqn": "aws_cdk.aws_ecr.TagStatus", + "id": "@aws-cdk/aws-ecr.TagStatus", + "members": Array [ + Object { + "displayName": "ANY", + "docs": Object { + "summary": "Rule applies to all images.", + }, + "fqn": "aws_cdk.aws_ecr.TagStatus.ANY", + "id": "@aws-cdk/aws-ecr.TagStatus.ANY", + }, + Object { + "displayName": "TAGGED", + "docs": Object { + "summary": "Rule applies to tagged images.", + }, + "fqn": "aws_cdk.aws_ecr.TagStatus.TAGGED", + "id": "@aws-cdk/aws-ecr.TagStatus.TAGGED", + }, + Object { + "displayName": "UNTAGGED", + "docs": Object { + "summary": "Rule applies to untagged images.", + }, + "fqn": "aws_cdk.aws_ecr.TagStatus.UNTAGGED", + "id": "@aws-cdk/aws-ecr.TagStatus.UNTAGGED", + }, + ], + }, + ], + "interfaces": Array [ + Object { + "displayName": "IRepository", + "docs": Object { + "summary": "Represents an ECR repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "implementations": Array [ + Object { + "displayName": "Repository", + "fqn": "aws_cdk.aws_ecr.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "RepositoryBase", + "fqn": "aws_cdk.aws_ecr.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "IRepository", + "fqn": "aws_cdk.aws_ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "instanceMethods": Array [ + Object { + "displayName": "add_to_resource_policy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy.parameter.statement", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "aws_cdk.aws_iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def add_to_resource_policy( + statement: PolicyStatement +)", + }, + Object { + "displayName": "grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant", + "id": "@aws-cdk/aws-ecr.IRepository.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "actions", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.actions", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def grant( + grantee: IGrantable, + actions: str +)", + }, + Object { + "displayName": "grant_pull", + "docs": Object { + "summary": "Grant the given identity permissions to pull images in this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull( + grantee: IGrantable +)", + }, + Object { + "displayName": "grant_pull_push", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull_push( + grantee: IGrantable +)", + }, + Object { + "displayName": "on_cloud_trail_event", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_cloud_trail_image_pushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch changes to all tags", + "displayName": "image_tag", + "docs": Object { + "summary": "Only watch changes to this image tag.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.image_tag", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.imageTag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +)", + }, + Object { + "displayName": "on_event", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_image_scan_completed", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch the changes to the repository with all image tags", + "displayName": "image_tags", + "docs": Object { + "remarks": "Leave it undefined to watch the full repository.", + "summary": "Only watch changes to the image tags spedified.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.image_tags", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.imageTags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + }, + ], + "usage": "def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +)", + }, + Object { + "displayName": "repository_uri_for_digest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "digest", + "docs": Object { + "summary": "Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted).", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest.parameter.digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_digest( + digest: str = None +)", + }, + Object { + "displayName": "repository_uri_for_tag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "tag", + "docs": Object { + "summary": "Image tag to use (tools usually default to \\"latest\\" if omitted).", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag.parameter.tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_tag( + tag: str = None +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IResource", + "fqn": "aws_cdk.core.IResource", + "id": "@aws-cdk/core.IResource", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "node", + "docs": Object { + "summary": "The construct tree node for this construct.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.node", + "id": "@aws-cdk/aws-ecr.IRepository.property.node", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ConstructNode", + "fqn": "aws_cdk.core.ConstructNode", + "id": "@aws-cdk/core.ConstructNode", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "node: ConstructNode", + }, + Object { + "default": undefined, + "displayName": "env", + "docs": Object { + "remarks": "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.", + "summary": "The environment this resource belongs to.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.env", + "id": "@aws-cdk/aws-ecr.IRepository.property.env", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ResourceEnvironment", + "fqn": "aws_cdk.core.ResourceEnvironment", + "id": "@aws-cdk/core.ResourceEnvironment", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "env: ResourceEnvironment", + }, + Object { + "default": undefined, + "displayName": "stack", + "docs": Object { + "summary": "The stack in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.stack", + "id": "@aws-cdk/aws-ecr.IRepository.property.stack", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Stack", + "fqn": "aws_cdk.core.Stack", + "id": "@aws-cdk/core.Stack", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "stack: Stack", + }, + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_arn", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_arn: str", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_name", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_uri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_uri", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_uri: str", + }, + ], + }, + ], + "structs": Array [ + Object { + "displayName": "CfnPublicRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_catalog_data: typing.Any", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_name", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_policy_text: typing.Any", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "tags: typing.List[CfnTag]", + }, + ], + "usage": "import aws_cdk.aws_ecr -Inferentia instances. +aws_cdk.aws_ecr.CfnPublicRepositoryProps( + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", + }, + Object { + "displayName": "CfnRegistryPolicyProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html", + ], + "summary": "Properties for defining a \`AWS::ECR::RegistryPolicy\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicyProps", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicyProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext", + ], + "summary": "\`AWS::ECR::RegistryPolicy.PolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRegistryPolicyProps.property.policy_text", + "id": "@aws-cdk/aws-ecr.CfnRegistryPolicyProps.property.policyText", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "policy_text: typing.Any", + }, + ], + "usage": "import aws_cdk.aws_ecr ---- +aws_cdk.aws_ecr.CfnRegistryPolicyProps( + policy_text: typing.Any +)", + }, + Object { + "displayName": "CfnReplicationConfigurationProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html", + ], + "summary": "Properties for defining a \`AWS::ECR::ReplicationConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfigurationProps", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfigurationProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "replication_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration", + ], + "summary": "\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfigurationProps.property.replication_configuration", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfigurationProps.property.replicationConfiguration", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ReplicationConfigurationProperty", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]", + }, + ], + "usage": "import aws_cdk.aws_ecr +aws_cdk.aws_ecr.CfnReplicationConfigurationProps( + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +)", + }, + Object { + "displayName": "CfnRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::Repository\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "encryption_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration", + ], + "summary": "\`AWS::ECR::Repository.EncryptionConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.encryption_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.encryptionConfiguration", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "encryption_configuration: typing.Any", + }, + Object { + "default": undefined, + "displayName": "image_scanning_configuration", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration", + ], + "summary": "\`AWS::ECR::Repository.ImageScanningConfiguration\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.image_scanning_configuration", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.imageScanningConfiguration", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "image_scanning_configuration: typing.Any", + }, + Object { + "default": undefined, + "displayName": "image_tag_mutability", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability", + ], + "summary": "\`AWS::ECR::Repository.ImageTagMutability\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.image_tag_mutability", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.imageTagMutability", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "image_tag_mutability: str", + }, + Object { + "default": undefined, + "displayName": "lifecycle_policy", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy", + ], + "summary": "\`AWS::ECR::Repository.LifecyclePolicy\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.lifecycle_policy", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.lifecyclePolicy", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "LifecyclePolicyProperty", + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty]", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname", + ], + "summary": "\`AWS::ECR::Repository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.repository_name", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::Repository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_policy_text: typing.Any", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags", + ], + "summary": "\`AWS::ECR::Repository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.tags", + "id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "tags: typing.List[CfnTag]", + }, + ], + "usage": "import aws_cdk.aws_ecr -### PatchType +aws_cdk.aws_ecr.CfnRepositoryProps( + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", + }, + Object { + "displayName": "LifecyclePolicyProperty", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html", + ], + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty", + "properties": Array [ + Object { + "default": undefined, + "displayName": "lifecycle_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext", + ], + "summary": "\`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty.property.lifecycle_policy_text", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty.property.lifecyclePolicyText", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "lifecycle_policy_text: str", + }, + Object { + "default": undefined, + "displayName": "registry_id", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid", + ], + "summary": "\`CfnRepository.LifecyclePolicyProperty.RegistryId\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty.property.registry_id", + "id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty.property.registryId", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "registry_id: str", + }, + ], + "usage": "import aws_cdk.aws_ecr -| **Name** | **Description** | -| --- | --- | -| [\`JSON\`](#softwareamazonawscdkservicesekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#softwareamazonawscdkservicesekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#softwareamazonawscdkservicesekspatchtypestrategic) | Strategic merge patch. | +aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( + lifecycle_policy_text: str = None, + registry_id: str = None +)", + }, + Object { + "displayName": "LifecycleRule", + "docs": Object { + "summary": "An ECR life cycle rule.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule", + "id": "@aws-cdk/aws-ecr.LifecycleRule", + "properties": Array [ + Object { + "default": "No description", + "displayName": "description", + "docs": Object { + "summary": "Describes the purpose of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.description", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "description: str", + }, + Object { + "default": undefined, + "displayName": "max_image_age", + "docs": Object { + "remarks": "Specify exactly one of maxImageCount and maxImageAge.", + "summary": "The maximum age of images to retain. The value must represent a number of days.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.max_image_age", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.maxImageAge", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Duration", + "fqn": "aws_cdk.core.Duration", + "id": "@aws-cdk/core.Duration", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "max_image_age: Duration", + }, + Object { + "default": undefined, + "displayName": "max_image_count", + "docs": Object { + "remarks": "Specify exactly one of maxImageCount and maxImageAge.", + "summary": "The maximum number of images to retain.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.max_image_count", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.maxImageCount", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[int, float]", + }, + "usage": "max_image_count: typing.Union[int, float]", + }, + Object { + "default": "Automatically assigned", + "displayName": "rule_priority", + "docs": Object { + "remarks": "All rules must have a unique priority, where lower numbers have +higher precedence. The first rule that matches is applied to an image. + +There can only be one rule with a tagStatus of Any, and it must have +the highest rulePriority. + +All rules without a specified priority will have incrementing priorities +automatically assigned to them, higher than any rules that DO have priorities.", + "summary": "Controls the order in which rules are evaluated (low to high).", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.rule_priority", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.rulePriority", + "optional": true, + "type": Object { + "formattingPattern": "typing.Union[int, float]", + }, + "usage": "rule_priority: typing.Union[int, float]", + }, + Object { + "default": undefined, + "displayName": "tag_prefix_list", + "docs": Object { + "remarks": "Only if tagStatus == TagStatus.Tagged", + "summary": "Select images that have ALL the given prefixes in their tag.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.tag_prefix_list", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.tagPrefixList", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + "usage": "tag_prefix_list: typing.List[str]", + }, + Object { + "default": "TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise", + "displayName": "tag_status", + "docs": Object { + "remarks": "Only one rule is allowed to select untagged images, and it must +have the highest rulePriority.", + "summary": "Select images based on tags.", + }, + "fqn": "aws_cdk.aws_ecr.LifecycleRule.property.tag_status", + "id": "@aws-cdk/aws-ecr.LifecycleRule.property.tagStatus", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagStatus", + "fqn": "aws_cdk.aws_ecr.TagStatus", + "id": "@aws-cdk/aws-ecr.TagStatus", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "tag_status: TagStatus", + }, + ], + "usage": "import aws_cdk.aws_ecr ---- +aws_cdk.aws_ecr.LifecycleRule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +)", + }, + Object { + "displayName": "OnCloudTrailImagePushedOptions", + "docs": Object { + "summary": "Options for the onCloudTrailImagePushed method.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", + "properties": Array [ + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.description", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "description: str", + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.event_pattern", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "event_pattern: EventPattern", + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.rule_name", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "rule_name: str", + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.target", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "target: IRuleTarget", + }, + Object { + "default": "- Watch changes to all tags", + "displayName": "image_tag", + "docs": Object { + "summary": "Only watch changes to this image tag.", + }, + "fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.image_tag", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.imageTag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "image_tag: str", + }, + ], + "usage": "import aws_cdk.aws_ecr -Values for \`kubectl patch\` --type argument. +aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +)", + }, + Object { + "displayName": "OnImageScanCompletedOptions", + "docs": Object { + "summary": "Options for the OnImageScanCompleted method.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", + "properties": Array [ + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.description", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "description: str", + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.event_pattern", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "event_pattern: EventPattern", + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.rule_name", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "rule_name: str", + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.target", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "target: IRuleTarget", + }, + Object { + "default": "- Watch the changes to the repository with all image tags", + "displayName": "image_tags", + "docs": Object { + "remarks": "Leave it undefined to watch the full repository.", + "summary": "Only watch changes to the image tags spedified.", + }, + "fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.image_tags", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.imageTags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + "usage": "image_tags: typing.List[str]", + }, + ], + "usage": "import aws_cdk.aws_ecr -#### \`JSON\` +aws_cdk.aws_ecr.OnImageScanCompletedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +)", + }, + Object { + "displayName": "ReplicationConfigurationProperty", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html", + ], + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty", + "properties": Array [ + Object { + "default": undefined, + "displayName": "rules", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules", + ], + "summary": "\`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty.property.rules", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty.property.rules", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ReplicationRuleProperty", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + ], + }, + ], + }, + "usage": "rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]]", + }, + ], + "usage": "import aws_cdk.aws_ecr -JSON Patch, RFC 6902. +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( + rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +)", + }, + Object { + "displayName": "ReplicationDestinationProperty", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html", + ], + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty", + "properties": Array [ + Object { + "default": undefined, + "displayName": "region", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region", + ], + "summary": "\`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.region", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.region", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "region: str", + }, + Object { + "default": undefined, + "displayName": "registry_id", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid", + ], + "summary": "\`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.registry_id", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.registryId", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "registry_id: str", + }, + ], + "usage": "import aws_cdk.aws_ecr ---- +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( + region: str, + registry_id: str +)", + }, + Object { + "displayName": "ReplicationRuleProperty", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html", + ], + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty", + "properties": Array [ + Object { + "default": undefined, + "displayName": "destinations", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations", + ], + "summary": "\`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty.property.destinations", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty.property.destinations", + "optional": undefined, + "type": Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "typing.Union[%, %]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IResolvable", + "fqn": "aws_cdk.core.IResolvable", + "id": "@aws-cdk/core.IResolvable", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ReplicationDestinationProperty", + "fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty", + "id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + ], + }, + ], + }, + "usage": "destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]]", + }, + ], + "usage": "import aws_cdk.aws_ecr +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( + destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +)", + }, + Object { + "displayName": "RepositoryAttributes", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryAttributes", + "id": "@aws-cdk/aws-ecr.RepositoryAttributes", + "properties": Array [ + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryAttributes.property.repository_arn", + "id": "@aws-cdk/aws-ecr.RepositoryAttributes.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_arn: str", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryAttributes.property.repository_name", + "id": "@aws-cdk/aws-ecr.RepositoryAttributes.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + ], + "usage": "import aws_cdk.aws_ecr -#### \`MERGE\` +aws_cdk.aws_ecr.RepositoryAttributes( + repository_arn: str, + repository_name: str +)", + }, + Object { + "displayName": "RepositoryProps", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.RepositoryProps", + "id": "@aws-cdk/aws-ecr.RepositoryProps", + "properties": Array [ + Object { + "default": "false", + "displayName": "image_scan_on_push", + "docs": Object { + "summary": "Enable the scan on push when creating the repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.image_scan_on_push", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.imageScanOnPush", + "optional": true, + "type": Object { + "formattingPattern": "bool", + }, + "usage": "image_scan_on_push: bool", + }, + Object { + "default": "TagMutability.MUTABLE", + "displayName": "image_tag_mutability", + "docs": Object { + "remarks": "If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten.", + "summary": "The tag mutability setting for the repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.image_tag_mutability", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.imageTagMutability", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TagMutability", + "fqn": "aws_cdk.aws_ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "image_tag_mutability: TagMutability", + }, + Object { + "default": "The default registry is assumed.", + "displayName": "lifecycle_registry_id", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html", + ], + "summary": "The AWS account ID associated with the registry that contains the repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.lifecycle_registry_id", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.lifecycleRegistryId", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "lifecycle_registry_id: str", + }, + Object { + "default": "No life cycle rules", + "displayName": "lifecycle_rules", + "docs": Object { + "summary": "Life cycle rules to apply to this registry.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.lifecycle_rules", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.lifecycleRules", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "LifecycleRule", + "fqn": "aws_cdk.aws_ecr.LifecycleRule", + "id": "@aws-cdk/aws-ecr.LifecycleRule", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "lifecycle_rules: typing.List[LifecycleRule]", + }, + Object { + "default": "RemovalPolicy.Retain", + "displayName": "removal_policy", + "docs": Object { + "summary": "Determine what happens to the repository when the resource/stack is deleted.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.removal_policy", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.removalPolicy", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "RemovalPolicy", + "fqn": "aws_cdk.core.RemovalPolicy", + "id": "@aws-cdk/core.RemovalPolicy", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "removal_policy: RemovalPolicy", + }, + Object { + "default": "Automatically generated name.", + "displayName": "repository_name", + "docs": Object { + "summary": "Name for this repository.", + }, + "fqn": "aws_cdk.aws_ecr.RepositoryProps.property.repository_name", + "id": "@aws-cdk/aws-ecr.RepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + ], + "usage": "import aws_cdk.aws_ecr -JSON Merge patch. +aws_cdk.aws_ecr.RepositoryProps( + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +)", + }, + ], + }, + "language": "python", + "metadata": Object { + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + "readme": "# Amazon ECR Construct Library ---- +--- -#### \`STRATEGIC\` +![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) -Strategic merge patch. +![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge) --- + -" -`; - -exports[`package installation does not run lifecycle hooks 1`] = ` -"# construct-library - -This is a test project to make sure the \`jsii-docgen\` cli property renders API documentation -for construct libraries. -# API Reference - -## Constructs - -### GreeterBucket +This package contains constructs for working with Amazon Elastic Container Registry. -#### Initializers +## Repositories -\`\`\`typescript -import { GreeterBucket } from 'construct-library' +Define a repository by creating a new instance of \`Repository\`. A repository +holds multiple verions of a single container image. -new GreeterBucket(scope: Construct, id: string, props?: BucketProps) +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(self, \\"Repository\\") \`\`\` -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#constructlibrarygreeterbucketparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#constructlibrarygreeterbucketparameterid)* | \`string\` | *No description.* | -| [\`props\`](#constructlibrarygreeterbucketparameterprops) | [\`@aws-cdk/aws-s3.BucketProps\`](#@aws-cdk/aws-s3.BucketProps) | *No description.* | - ---- +## Image scanning -##### \`scope\`Required +Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable \`imageScanOnPush\` in the properties -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(stack, \\"Repo\\", + image_scan_on_push=True +) +\`\`\` ---- +To create an \`onImageScanCompleted\` event rule and trigger the event target -##### \`id\`Required +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.on_image_scan_completed(\\"ImageScanComplete\\").add_target(...) +\`\`\` -- *Type:* \`string\` +### Authorization Token ---- +Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull +images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and +additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests. +More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth). -##### \`props\`Optional +A Docker authorization token can be obtained using the \`GetAuthorizationToken\` ECR API. The following code snippets +grants an IAM user access to call this API. -- *Type:* [\`@aws-cdk/aws-s3.BucketProps\`](#@aws-cdk/aws-s3.BucketProps) +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr ---- +user = iam.User(self, \\"User\\", ...) +ecr.AuthorizationToken.grant_read(user) +\`\`\` -#### Methods +If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from +higher rate and bandwidth limits. -| **Name** | **Description** | -| --- | --- | -| [\`greet\`](#constructlibrarygreeterbucketgreet) | *No description.* | +> See \`Pricing\` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html). ---- +The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery. -##### \`greet\` +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr -\`\`\`typescript -public greet() +user = iam.User(self, \\"User\\", ...) +ecr.PublicGalleryAuthorizationToken.grant_read(user) \`\`\` +This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth). +### Image tag immutability +You can set tag immutability on images in our repository using the \`imageTagMutability\` construct prop. +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +ecr.Repository(stack, \\"Repo\\", image_tag_mutability=ecr.TagMutability.IMMUTABLE) +\`\`\` +## Automatically clean up repositories +You can set life cycle rules to automatically clean up old images from your +repository. The first life cycle rule that matches an image will be applied +against that image. For example, the following deletes images older than +30 days, while keeping all images tagged with prod (note that the order +is important here): -" +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.add_lifecycle_rule(tag_prefix_list=[\\"prod\\"], max_image_count=9999) +repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) +\`\`\`", + "version": "0.1", +} `; -exports[`python for package 1`] = ` +exports[`python for package 2`] = ` "# Amazon ECR Construct Library --- @@ -57454,17 +59482,17 @@ repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -57481,34 +59509,34 @@ aws_cdk.aws_ecr.CfnPublicRepository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`repository_catalog_data\`Optional +##### \`repository_catalog_data\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -57516,9 +59544,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -57526,9 +59554,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -57536,9 +59564,70 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional + +- *Type:* typing.List[aws_cdk.core.CfnTag] + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* aws_cdk.core.TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| tags | aws_cdk.core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* aws_cdk.core.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -57546,15 +59635,131 @@ scoped id of the resource. --- -#### Methods +##### \`repository_catalog_data\`Required + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRegistryPolicy + +- *Implements:* aws_cdk.core.IInspectable + +A CloudFormation \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicy( + scope: Construct, + id: str, + policy_text: typing.Any +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`scope\`Required + +- *Type:* aws_cdk.core.Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`policy_text\`Required + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -57562,156 +59767,41 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnpublicrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attr_registry_id | str | *No description.* | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attr_arn\`Required +##### \`attr_registry_id\`Required \`\`\`python -attr_arn: str -\`\`\` - -- *Type:* \`str\` - ---- - -##### \`tags\`Required - -\`\`\`python -tags: TagManager -\`\`\` - -- *Type:* [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) - -\`AWS::ECR::PublicRepository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) - ---- - -##### \`repository_catalog_data\`Required - -\`\`\`python -repository_catalog_data: typing.Any -\`\`\` - -- *Type:* \`typing.Any\` - -\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) - ---- - -##### \`repository_policy_text\`Required - -\`\`\`python -repository_policy_text: typing.Any -\`\`\` - -- *Type:* \`typing.Any\` - -\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) - ---- - -##### \`repository_name\`Optional - -\`\`\`python -repository_name: str +attr_registry_id: str \`\`\` -- *Type:* \`str\` - -\`AWS::ECR::PublicRepository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) +- *Type:* str --- -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`str\` - -The CloudFormation resource type name for this resource class. - ---- - -### CfnRegistryPolicy - -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) - -A CloudFormation \`AWS::ECR::RegistryPolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) - -#### Initializers +##### \`policy_text\`Required \`\`\`python -import aws_cdk.aws_ecr - -aws_cdk.aws_ecr.CfnRegistryPolicy( - scope: Construct, - id: str, - policy_text: typing.Any -) +policy_text: typing.Any \`\`\` -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnregistrypolicyparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnregistrypolicyparameterid)* | \`str\` | scoped id of the resource. | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropsparameterpolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`scope\`Required - -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) - -scope in which this resource is defined. - ---- - -##### \`id\`Required - -- *Type:* \`str\` - -scoped id of the resource. - ---- - -##### \`policy_text\`Required - -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -57719,89 +59809,35 @@ scoped id of the resource. --- -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#awscdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | - ---- - -##### \`inspect\` - -\`\`\`python -def inspect( - inspector: TreeInspector -) -\`\`\` - -###### \`inspector\`Required - -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) - -tree inspector to collect and process attributes. - ---- - - -#### Properties +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`str\` | *No description.* | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`attr_registry_id\`Required - -\`\`\`python -attr_registry_id: str -\`\`\` - -- *Type:* \`str\` +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`policy_text\`Required +##### \`CFN_RESOURCE_TYPE_NAME\`Required \`\`\`python -policy_text: typing.Any +CFN_RESOURCE_TYPE_NAME: str \`\`\` -- *Type:* \`typing.Any\` - -\`AWS::ECR::RegistryPolicy.PolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -57815,31 +59851,31 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnreplicationconfigurationparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnreplicationconfigurationparameterid)* | \`str\` | scoped id of the resource. | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropsparameterreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -57847,15 +59883,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -57863,41 +59899,41 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`str\` | *No description.* | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attr_registry_id | str | *No description.* | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attr_registry_id\`Required +##### \`attr_registry_id\`Required \`\`\`python attr_registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required \`\`\`python replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -57905,31 +59941,35 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`str\` +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -57949,37 +59989,37 @@ aws_cdk.aws_ecr.CfnRepository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropsparameterencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropsparameterimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropsparameterimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropsparameterlifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`encryption_configuration\`Optional +##### \`encryption_configuration\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -57987,9 +60027,9 @@ scoped id of the resource. --- -##### \`image_scanning_configuration\`Optional +##### \`image_scanning_configuration\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -57997,9 +60037,9 @@ scoped id of the resource. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -58007,9 +60047,9 @@ scoped id of the resource. --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -58017,9 +60057,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -58027,9 +60067,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -58037,9 +60077,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::Repository.Tags\`. @@ -58047,15 +60087,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -58063,58 +60103,58 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`attr_repository_uri\`](#awscdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attr_arn | str | *No description.* | +| attr_repository_uri | str | *No description.* | +| tags | aws_cdk.core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_repository_uri\`Required +##### \`attr_repository_uri\`Required \`\`\`python attr_repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) +- *Type:* aws_cdk.core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -58122,13 +60162,13 @@ tags: TagManager --- -##### \`encryption_configuration\`Required +##### \`encryption_configuration\`Required \`\`\`python encryption_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -58136,13 +60176,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Required +##### \`image_scanning_configuration\`Required \`\`\`python image_scanning_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -58150,13 +60190,13 @@ image_scanning_configuration: typing.Any --- -##### \`repository_policy_text\`Required +##### \`repository_policy_text\`Required \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -58164,13 +60204,13 @@ repository_policy_text: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -58178,13 +60218,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional \`\`\`python lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -58192,13 +60232,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -58206,27 +60246,31 @@ repository_name: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -58245,41 +60289,41 @@ aws_cdk.aws_ecr.Repository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositoryparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositoryparameterid)* | \`str\` | *No description.* | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropsparameterimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropsparameterimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropsparameterlifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropsparameterlifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropsparameterremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropsparameterrepositoryname) | \`str\` | Name for this repository. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | aws_cdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`image_scan_on_push\`Optional +##### \`image_scan_on_push\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -58288,54 +60332,54 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycle_registry_id\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycle_rules\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* typing.List[LifecycleRule] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removal_policy\`Optional -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) +- *Type:* aws_cdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name. Name for this repository. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_lifecycle_rule\`](#awscdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| add_lifecycle_rule | Add a life cycle rule to the repository. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | --- -##### \`add_lifecycle_rule\` +##### \`add_lifecycle_rule\` \`\`\`python def add_lifecycle_rule( @@ -58348,18 +60392,18 @@ def add_lifecycle_rule( ) \`\`\` -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description Describes the purpose of the rule. --- -###### \`max_image_age\`Optional +###### \`max_image_age\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -58367,9 +60411,9 @@ Specify exactly one of maxImageCount and maxImageAge. --- -###### \`max_image_count\`Optional +###### \`max_image_count\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] The maximum number of images to retain. @@ -58377,9 +60421,9 @@ Specify exactly one of maxImageCount and maxImageAge. --- -###### \`rule_priority\`Optional +###### \`rule_priority\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -58388,9 +60432,9 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -###### \`tag_prefix_list\`Optional +###### \`tag_prefix_list\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] Select images that have ALL the given prefixes in their tag. @@ -58398,9 +60442,9 @@ Only if tagStatus == TagStatus.Tagged --- -###### \`tag_status\`Optional +###### \`tag_status\`Optional -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -58409,7 +60453,7 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -58417,24 +60461,24 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arn_for_local_repository\`](#awscdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`from_repository_arn\`](#awscdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`from_repository_attributes\`](#awscdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`from_repository_name\`](#awscdkawsecrrepositoryfromrepositoryname) | *No description.* | +| arn_for_local_repository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| from_repository_arn | *No description.* | +| from_repository_attributes | Import a repository. | +| from_repository_name | *No description.* | --- -##### \`arn_for_local_repository\` +##### \`arn_for_local_repository\` \`\`\`python import aws_cdk.aws_ecr @@ -58446,25 +60490,25 @@ aws_cdk.aws_ecr.Repository.arn_for_local_repository( ) \`\`\` -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.IConstruct\`](#constructs.IConstruct) +- *Type:* constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_arn\` +##### \`from_repository_arn\` \`\`\`python import aws_cdk.aws_ecr @@ -58476,25 +60520,25 @@ aws_cdk.aws_ecr.Repository.from_repository_arn( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_arn\`Required +###### \`repository_arn\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_attributes\` +##### \`from_repository_attributes\` \`\`\`python import aws_cdk.aws_ecr @@ -58507,31 +60551,31 @@ aws_cdk.aws_ecr.Repository.from_repository_attributes( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_arn\`Required +###### \`repository_arn\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_name\` +##### \`from_repository_name\` \`\`\`python import aws_cdk.aws_ecr @@ -58543,67 +60587,67 @@ aws_cdk.aws_ecr.Repository.from_repository_name( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`aws_cdk.aws_ecr.IRepository\`](#aws_cdk.aws_ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -58620,39 +60664,39 @@ aws_cdk.aws_ecr.RepositoryBase( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositorybaseparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositorybaseparameterid)* | \`str\` | *No description.* | -| [\`account\`](#awscdkcoreresourcepropsparameteraccount) | \`str\` | The AWS account ID this resource belongs to. | -| [\`environment_from_arn\`](#awscdkcoreresourcepropsparameterenvironmentfromarn) | \`str\` | ARN to deduce region and account from. | -| [\`physical_name\`](#awscdkcoreresourcepropsparameterphysicalname) | \`str\` | The value passed in by users to the physical name prop of the resource. | -| [\`region\`](#awscdkcoreresourcepropsparameterregion) | \`str\` | The AWS region this resource belongs to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| account | str | The AWS account ID this resource belongs to. | +| environment_from_arn | str | ARN to deduce region and account from. | +| physical_name | str | The value passed in by users to the physical name prop of the resource. | +| region | str | The AWS region this resource belongs to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`account\`Optional +##### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* the resource is in the same account as the stack it belongs to The AWS account ID this resource belongs to. --- -##### \`environment_from_arn\`Optional +##### \`environment_from_arn\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. ARN to deduce region and account from. @@ -58661,9 +60705,9 @@ The ARN is parsed and the account and region are taken from the ARN. This should --- -##### \`physical_name\`Optional +##### \`physical_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The physical name will be allocated by CloudFormation at deployment time The value passed in by users to the physical name prop of the resource. @@ -58672,33 +60716,33 @@ The value passed in by users to the physical name prop of the resource. --- -##### \`region\`Optional +##### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* the resource is in the same region as the stack it belongs to The AWS region this resource belongs to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to use the images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repository_uri_for_digest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -58706,13 +60750,13 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`python def grant( @@ -58721,19 +60765,19 @@ def grant( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`grant_pull\` +##### \`grant_pull\` \`\`\`python def grant_pull( @@ -58741,13 +60785,13 @@ def grant_pull( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grant_pull_push\` \`\`\`python def grant_pull_push( @@ -58755,13 +60799,13 @@ def grant_pull_push( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`on_cloud_trail_event\` \`\`\`python def on_cloud_trail_event( @@ -58773,55 +60817,55 @@ def on_cloud_trail_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_cloud_trail_image_pushed\` +##### \`on_cloud_trail_image_pushed\` \`\`\`python def on_cloud_trail_image_pushed( @@ -58834,64 +60878,64 @@ def on_cloud_trail_image_pushed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tag\`Optional +###### \`image_tag\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -##### \`on_event\` +##### \`on_event\` \`\`\`python def on_event( @@ -58903,53 +60947,53 @@ def on_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_image_scan_completed\` +##### \`on_image_scan_completed\` \`\`\`python def on_image_scan_completed( @@ -58962,57 +61006,57 @@ def on_image_scan_completed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tags\`Optional +###### \`image_tags\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -59021,7 +61065,7 @@ Leave it undefined to watch the full repository. --- -##### \`repository_uri_for_digest\` +##### \`repository_uri_for_digest\` \`\`\`python def repository_uri_for_digest( @@ -59029,15 +61073,15 @@ def repository_uri_for_digest( ) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* str Optional image digest. --- -##### \`repository_uri_for_tag\` +##### \`repository_uri_for_tag\` \`\`\`python def repository_uri_for_tag( @@ -59045,56 +61089,56 @@ def repository_uri_for_tag( ) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* str Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorybasepropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorybasepropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrrepositorybasepropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -##### \`repository_uri\`Required +##### \`repository_uri\`Required \`\`\`python repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URI of this repository (represents the latest image):. @@ -59103,15 +61147,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59124,24 +61168,24 @@ aws_cdk.aws_ecr.CfnPublicRepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repository_catalog_data\`Optional +##### \`repository_catalog_data\`Optional \`\`\`python repository_catalog_data: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -59149,13 +61193,13 @@ repository_catalog_data: typing.Any --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -59163,13 +61207,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -59177,13 +61221,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::PublicRepository.Tags\`. @@ -59191,13 +61235,13 @@ tags: typing.List[CfnTag] --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59207,21 +61251,21 @@ aws_cdk.aws_ecr.CfnRegistryPolicyProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policy_text\`Required +##### \`policy_text\`Required \`\`\`python policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -59229,13 +61273,13 @@ policy_text: typing.Any --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59245,21 +61289,21 @@ aws_cdk.aws_ecr.CfnReplicationConfigurationProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required \`\`\`python replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -59267,13 +61311,13 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59289,27 +61333,27 @@ aws_cdk.aws_ecr.CfnRepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropspropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryption_configuration\`Optional +##### \`encryption_configuration\`Optional \`\`\`python encryption_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -59317,13 +61361,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Optional +##### \`image_scanning_configuration\`Optional \`\`\`python image_scanning_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -59331,13 +61375,13 @@ image_scanning_configuration: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -59345,13 +61389,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional \`\`\`python lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -59359,13 +61403,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -59373,13 +61417,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -59387,13 +61431,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::Repository.Tags\`. @@ -59401,11 +61445,11 @@ tags: typing.List[CfnTag] --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59416,22 +61460,22 @@ aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecycle_policy_text\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registry_id\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecycle_policy_text | str | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registry_id | str | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecycle_policy_text\`Optional +##### \`lifecycle_policy_text\`Optional \`\`\`python lifecycle_policy_text: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -59439,13 +61483,13 @@ lifecycle_policy_text: str --- -##### \`registry_id\`Optional +##### \`registry_id\`Optional \`\`\`python registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -59453,11 +61497,11 @@ registry_id: str --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59472,39 +61516,39 @@ aws_cdk.aws_ecr.LifecycleRule( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecrlifecyclerulepropertydescription) | \`str\` | Describes the purpose of the rule. | -| [\`max_image_age\`](#awscdkawsecrlifecyclerulepropertymaximageage) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`max_image_count\`](#awscdkawsecrlifecyclerulepropertymaximagecount) | \`typing.Union[int, float]\` | The maximum number of images to retain. | -| [\`rule_priority\`](#awscdkawsecrlifecyclerulepropertyrulepriority) | \`typing.Union[int, float]\` | Controls the order in which rules are evaluated (low to high). | -| [\`tag_prefix_list\`](#awscdkawsecrlifecyclerulepropertytagprefixlist) | typing.List[\`str\`] | Select images that have ALL the given prefixes in their tag. | -| [\`tag_status\`](#awscdkawsecrlifecyclerulepropertytagstatus) | [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) | Select images based on tags. | +| description | str | Describes the purpose of the rule. | +| max_image_age | aws_cdk.core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| max_image_count | typing.Union[int, float] | The maximum number of images to retain. | +| rule_priority | typing.Union[int, float] | Controls the order in which rules are evaluated (low to high). | +| tag_prefix_list | typing.List[str] | Select images that have ALL the given prefixes in their tag. | +| tag_status | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description Describes the purpose of the rule. --- -##### \`max_image_age\`Optional +##### \`max_image_age\`Optional \`\`\`python max_image_age: Duration \`\`\` -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -59512,13 +61556,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`max_image_count\`Optional +##### \`max_image_count\`Optional \`\`\`python max_image_count: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] The maximum number of images to retain. @@ -59526,13 +61570,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rule_priority\`Optional +##### \`rule_priority\`Optional \`\`\`python rule_priority: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -59541,13 +61585,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tag_prefix_list\`Optional +##### \`tag_prefix_list\`Optional \`\`\`python tag_prefix_list: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] Select images that have ALL the given prefixes in their tag. @@ -59555,13 +61599,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tag_status\`Optional +##### \`tag_status\`Optional \`\`\`python tag_status: TagStatus \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -59570,11 +61614,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59588,92 +61632,92 @@ aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tag\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`str\` | Only watch changes to this image tag. | +| description | str | A description of the rule's purpose. | +| event_pattern | aws_cdk.aws_events.EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | aws_cdk.aws_events.IRuleTarget | The target to register for the event. | +| image_tag | str | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`event_pattern\`Optional \`\`\`python event_pattern: EventPattern \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`rule_name\`Optional \`\`\`python rule_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`python target: IRuleTarget \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tag\`Optional +##### \`image_tag\`Optional \`\`\`python image_tag: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59687,81 +61731,81 @@ aws_cdk.aws_ecr.OnImageScanCompletedOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecronimagescancompletedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecronimagescancompletedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecronimagescancompletedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tags\`](#awscdkawsecronimagescancompletedoptionspropertyimagetags) | typing.List[\`str\`] | Only watch changes to the image tags spedified. | +| description | str | A description of the rule's purpose. | +| event_pattern | aws_cdk.aws_events.EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | aws_cdk.aws_events.IRuleTarget | The target to register for the event. | +| image_tags | typing.List[str] | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`event_pattern\`Optional \`\`\`python event_pattern: EventPattern \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`rule_name\`Optional \`\`\`python rule_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`python target: IRuleTarget \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tags\`Optional +##### \`image_tags\`Optional \`\`\`python image_tags: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -59770,11 +61814,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59784,21 +61828,21 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#awscdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationRuleProperty]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required \`\`\`python rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] +- *Type:* typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationRuleProperty]]] \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -59806,11 +61850,11 @@ rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Replicati --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59821,22 +61865,22 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registry_id\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registry_id | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required \`\`\`python region: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -59844,13 +61888,13 @@ region: str --- -##### \`registry_id\`Required +##### \`registry_id\`Required \`\`\`python registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -59858,11 +61902,11 @@ registry_id: str --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59872,21 +61916,21 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#awscdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationDestinationProperty]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required \`\`\`python destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] +- *Type:* typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationDestinationProperty]]] \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -59894,9 +61938,9 @@ destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Re --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59907,38 +61951,38 @@ aws_cdk.aws_ecr.RepositoryAttributes( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositoryattributespropertyrepositoryarn)* | \`str\` | *No description.* | -| [\`repository_name\`](#awscdkawsecrrepositoryattributespropertyrepositoryname)* | \`str\` | *No description.* | +| repository_arn | str | *No description.* | +| repository_name | str | *No description.* | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -59953,39 +61997,39 @@ aws_cdk.aws_ecr.RepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropspropertyimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropspropertyimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropspropertylifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropspropertylifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropspropertyremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropspropertyrepositoryname) | \`str\` | Name for this repository. | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | aws_cdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | --- -##### \`image_scan_on_push\`Optional +##### \`image_scan_on_push\`Optional \`\`\`python image_scan_on_push: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: TagMutability \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -59994,78 +62038,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycle_registry_id\`Optional \`\`\`python lifecycle_registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycle_rules\`Optional \`\`\`python lifecycle_rules: typing.List[LifecycleRule] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* typing.List[LifecycleRule] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removal_policy\`Optional \`\`\`python removal_policy: RemovalPolicy \`\`\` -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) +- *Type:* aws_cdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grant_read | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -60075,30 +62119,30 @@ aws_cdk.aws_ecr.AuthorizationToken.grant_read( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grant_read | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -60108,42 +62152,42 @@ aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`aws_cdk.core.IResource\`](#aws_cdk.core.IResource) +- *Extends:* aws_cdk.core.IResource -- *Implemented By:* [\`aws_cdk.aws_ecr.Repository\`](#aws_cdk.aws_ecr.Repository), [\`aws_cdk.aws_ecr.RepositoryBase\`](#aws_cdk.aws_ecr.RepositoryBase), [\`aws_cdk.aws_ecr.IRepository\`](#aws_cdk.aws_ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to pull images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repository_uri_for_digest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -60151,13 +62195,13 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`python def grant( @@ -60166,19 +62210,19 @@ def grant( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`grant_pull\` +##### \`grant_pull\` \`\`\`python def grant_pull( @@ -60186,13 +62230,13 @@ def grant_pull( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grant_pull_push\` \`\`\`python def grant_pull_push( @@ -60200,13 +62244,13 @@ def grant_pull_push( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`on_cloud_trail_event\` \`\`\`python def on_cloud_trail_event( @@ -60218,55 +62262,55 @@ def on_cloud_trail_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_cloud_trail_image_pushed\` +##### \`on_cloud_trail_image_pushed\` \`\`\`python def on_cloud_trail_image_pushed( @@ -60279,64 +62323,64 @@ def on_cloud_trail_image_pushed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tag\`Optional +###### \`image_tag\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -##### \`on_event\` +##### \`on_event\` \`\`\`python def on_event( @@ -60348,53 +62392,53 @@ def on_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_image_scan_completed\` +##### \`on_image_scan_completed\` \`\`\`python def on_image_scan_completed( @@ -60407,57 +62451,57 @@ def on_image_scan_completed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tags\`Optional +###### \`image_tags\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -60466,7 +62510,7 @@ Leave it undefined to watch the full repository. --- -##### \`repository_uri_for_digest\` +##### \`repository_uri_for_digest\` \`\`\`python def repository_uri_for_digest( @@ -60474,15 +62518,15 @@ def repository_uri_for_digest( ) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* str Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repository_uri_for_tag\` +##### \`repository_uri_for_tag\` \`\`\`python def repository_uri_for_tag( @@ -60490,46 +62534,46 @@ def repository_uri_for_tag( ) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* str Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) | The stack in which this resource is defined. | -| [\`repository_arn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| node | aws_cdk.core.ConstructNode | The construct tree node for this construct. | +| env | aws_cdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws_cdk.core.Stack | The stack in which this resource is defined. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`python node: ConstructNode \`\`\` -- *Type:* [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) +- *Type:* aws_cdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`python env: ResourceEnvironment \`\`\` -- *Type:* [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) +- *Type:* aws_cdk.core.ResourceEnvironment The environment this resource belongs to. @@ -60537,49 +62581,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`python stack: Stack \`\`\` -- *Type:* [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) +- *Type:* aws_cdk.core.Stack The stack in which this resource is defined. --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -##### \`repository_uri\`Required +##### \`repository_uri\`Required \`\`\`python repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URI of this repository (represents the latest image):. @@ -60587,60 +62631,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#awscdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#awscdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#awscdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -60753,17 +62797,17 @@ repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) \`\`\` # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -60780,34 +62824,34 @@ aws_cdk.aws_ecr.CfnPublicRepository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`repository_catalog_data\`Optional +##### \`repository_catalog_data\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -60815,9 +62859,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -60825,9 +62869,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -60835,9 +62879,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::PublicRepository.Tags\`. @@ -60845,15 +62889,192 @@ scoped id of the resource. --- -#### Methods +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* aws_cdk.core.TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| tags | aws_cdk.core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` + +- *Type:* aws_cdk.core.TagManager + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +##### \`repository_catalog_data\`Required + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRegistryPolicy + +- *Implements:* aws_cdk.core.IInspectable + +A CloudFormation \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicy( + scope: Construct, + id: str, + policy_text: typing.Any +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`scope\`Required + +- *Type:* aws_cdk.core.Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`policy_text\`Required + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -60861,156 +63082,41 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnpublicrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attr_registry_id | str | *No description.* | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attr_arn\`Required +##### \`attr_registry_id\`Required \`\`\`python -attr_arn: str -\`\`\` - -- *Type:* \`str\` - ---- - -##### \`tags\`Required - -\`\`\`python -tags: TagManager -\`\`\` - -- *Type:* [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) - -\`AWS::ECR::PublicRepository.Tags\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) - ---- - -##### \`repository_catalog_data\`Required - -\`\`\`python -repository_catalog_data: typing.Any -\`\`\` - -- *Type:* \`typing.Any\` - -\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) - ---- - -##### \`repository_policy_text\`Required - -\`\`\`python -repository_policy_text: typing.Any -\`\`\` - -- *Type:* \`typing.Any\` - -\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) - ---- - -##### \`repository_name\`Optional - -\`\`\`python -repository_name: str +attr_registry_id: str \`\`\` -- *Type:* \`str\` - -\`AWS::ECR::PublicRepository.RepositoryName\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) +- *Type:* str --- -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`str\` - -The CloudFormation resource type name for this resource class. - ---- - -### CfnRegistryPolicy - -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) - -A CloudFormation \`AWS::ECR::RegistryPolicy\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) - -#### Initializers +##### \`policy_text\`Required \`\`\`python -import aws_cdk.aws_ecr - -aws_cdk.aws_ecr.CfnRegistryPolicy( - scope: Construct, - id: str, - policy_text: typing.Any -) +policy_text: typing.Any \`\`\` -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnregistrypolicyparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnregistrypolicyparameterid)* | \`str\` | scoped id of the resource. | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropsparameterpolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | - ---- - -##### \`scope\`Required - -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) - -scope in which this resource is defined. - ---- - -##### \`id\`Required - -- *Type:* \`str\` - -scoped id of the resource. - ---- - -##### \`policy_text\`Required - -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -61018,89 +63124,35 @@ scoped id of the resource. --- -#### Methods - -| **Name** | **Description** | -| --- | --- | -| [\`inspect\`](#awscdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | - ---- - -##### \`inspect\` - -\`\`\`python -def inspect( - inspector: TreeInspector -) -\`\`\` - -###### \`inspector\`Required - -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) - -tree inspector to collect and process attributes. - ---- - - -#### Properties +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`str\` | *No description.* | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`attr_registry_id\`Required +##### \`CFN_RESOURCE_TYPE_NAME\`Required \`\`\`python -attr_registry_id: str +CFN_RESOURCE_TYPE_NAME: str \`\`\` -- *Type:* \`str\` - ---- - -##### \`policy_text\`Required - -\`\`\`python -policy_text: typing.Any -\`\`\` - -- *Type:* \`typing.Any\` - -\`AWS::ECR::RegistryPolicy.PolicyText\`. - -> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) - ---- - -#### Constants - -| **Name** | **Type** | **Description** | -| --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | - ---- - -##### \`CFN_RESOURCE_TYPE_NAME\` - -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -61114,31 +63166,31 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnreplicationconfigurationparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnreplicationconfigurationparameterid)* | \`str\` | scoped id of the resource. | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropsparameterreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -61146,15 +63198,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -61162,41 +63214,41 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_registry_id\`](#awscdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`str\` | *No description.* | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attr_registry_id | str | *No description.* | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attr_registry_id\`Required +##### \`attr_registry_id\`Required \`\`\`python attr_registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required \`\`\`python replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -61204,31 +63256,35 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`str\` +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`aws_cdk.core.IInspectable\`](#aws_cdk.core.IInspectable) +- *Implements:* aws_cdk.core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -61248,37 +63304,37 @@ aws_cdk.aws_ecr.CfnRepository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropsparameterencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropsparameterimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropsparameterimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropsparameterlifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`encryption_configuration\`Optional +##### \`encryption_configuration\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -61286,9 +63342,9 @@ scoped id of the resource. --- -##### \`image_scanning_configuration\`Optional +##### \`image_scanning_configuration\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -61296,9 +63352,9 @@ scoped id of the resource. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -61306,9 +63362,9 @@ scoped id of the resource. --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -61316,9 +63372,9 @@ scoped id of the resource. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -61326,9 +63382,9 @@ scoped id of the resource. --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -61336,9 +63392,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::Repository.Tags\`. @@ -61346,15 +63402,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -61362,58 +63418,58 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsecrcfnrepositorypropertyattrarn)* | \`str\` | *No description.* | -| [\`attr_repository_uri\`](#awscdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnrepositorypropertytags)* | [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attr_arn | str | *No description.* | +| attr_repository_uri | str | *No description.* | +| tags | aws_cdk.core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_repository_uri\`Required +##### \`attr_repository_uri\`Required \`\`\`python attr_repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.core.TagManager\`](#aws_cdk.core.TagManager) +- *Type:* aws_cdk.core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -61421,13 +63477,13 @@ tags: TagManager --- -##### \`encryption_configuration\`Required +##### \`encryption_configuration\`Required \`\`\`python encryption_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -61435,13 +63491,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Required +##### \`image_scanning_configuration\`Required \`\`\`python image_scanning_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -61449,13 +63505,13 @@ image_scanning_configuration: typing.Any --- -##### \`repository_policy_text\`Required +##### \`repository_policy_text\`Required \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -61463,13 +63519,13 @@ repository_policy_text: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -61477,13 +63533,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional \`\`\`python lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -61491,13 +63547,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -61505,27 +63561,31 @@ repository_name: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`str\` +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -61544,41 +63604,41 @@ aws_cdk.aws_ecr.Repository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositoryparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositoryparameterid)* | \`str\` | *No description.* | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropsparameterimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropsparameterimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropsparameterlifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropsparameterlifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropsparameterremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropsparameterrepositoryname) | \`str\` | Name for this repository. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | aws_cdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`image_scan_on_push\`Optional +##### \`image_scan_on_push\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -61587,54 +63647,54 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycle_registry_id\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycle_rules\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* typing.List[LifecycleRule] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removal_policy\`Optional -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) +- *Type:* aws_cdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name. Name for this repository. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_lifecycle_rule\`](#awscdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| add_lifecycle_rule | Add a life cycle rule to the repository. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | --- -##### \`add_lifecycle_rule\` +##### \`add_lifecycle_rule\` \`\`\`python def add_lifecycle_rule( @@ -61647,18 +63707,18 @@ def add_lifecycle_rule( ) \`\`\` -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description Describes the purpose of the rule. --- -###### \`max_image_age\`Optional +###### \`max_image_age\`Optional -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -61666,9 +63726,9 @@ Specify exactly one of maxImageCount and maxImageAge. --- -###### \`max_image_count\`Optional +###### \`max_image_count\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] The maximum number of images to retain. @@ -61676,9 +63736,9 @@ Specify exactly one of maxImageCount and maxImageAge. --- -###### \`rule_priority\`Optional +###### \`rule_priority\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -61687,9 +63747,9 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -###### \`tag_prefix_list\`Optional +###### \`tag_prefix_list\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] Select images that have ALL the given prefixes in their tag. @@ -61697,9 +63757,9 @@ Only if tagStatus == TagStatus.Tagged --- -###### \`tag_status\`Optional +###### \`tag_status\`Optional -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -61708,7 +63768,7 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -61716,24 +63776,24 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arn_for_local_repository\`](#awscdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`from_repository_arn\`](#awscdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`from_repository_attributes\`](#awscdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`from_repository_name\`](#awscdkawsecrrepositoryfromrepositoryname) | *No description.* | +| arn_for_local_repository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| from_repository_arn | *No description.* | +| from_repository_attributes | Import a repository. | +| from_repository_name | *No description.* | --- -##### \`arn_for_local_repository\` +##### \`arn_for_local_repository\` \`\`\`python import aws_cdk.aws_ecr @@ -61745,25 +63805,25 @@ aws_cdk.aws_ecr.Repository.arn_for_local_repository( ) \`\`\` -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.IConstruct\`](#constructs.IConstruct) +- *Type:* constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_arn\` +##### \`from_repository_arn\` \`\`\`python import aws_cdk.aws_ecr @@ -61775,25 +63835,25 @@ aws_cdk.aws_ecr.Repository.from_repository_arn( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_arn\`Required +###### \`repository_arn\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_attributes\` +##### \`from_repository_attributes\` \`\`\`python import aws_cdk.aws_ecr @@ -61806,31 +63866,31 @@ aws_cdk.aws_ecr.Repository.from_repository_attributes( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_arn\`Required +###### \`repository_arn\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`from_repository_name\` +##### \`from_repository_name\` \`\`\`python import aws_cdk.aws_ecr @@ -61842,67 +63902,67 @@ aws_cdk.aws_ecr.Repository.from_repository_name( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`repository_name\`Required +###### \`repository_name\`Required -- *Type:* \`str\` +- *Type:* str --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`aws_cdk.aws_ecr.IRepository\`](#aws_cdk.aws_ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`python import aws_cdk.aws_ecr @@ -61919,39 +63979,39 @@ aws_cdk.aws_ecr.RepositoryBase( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositorybaseparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositorybaseparameterid)* | \`str\` | *No description.* | -| [\`account\`](#awscdkcoreresourcepropsparameteraccount) | \`str\` | The AWS account ID this resource belongs to. | -| [\`environment_from_arn\`](#awscdkcoreresourcepropsparameterenvironmentfromarn) | \`str\` | ARN to deduce region and account from. | -| [\`physical_name\`](#awscdkcoreresourcepropsparameterphysicalname) | \`str\` | The value passed in by users to the physical name prop of the resource. | -| [\`region\`](#awscdkcoreresourcepropsparameterregion) | \`str\` | The AWS region this resource belongs to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| account | str | The AWS account ID this resource belongs to. | +| environment_from_arn | str | ARN to deduce region and account from. | +| physical_name | str | The value passed in by users to the physical name prop of the resource. | +| region | str | The AWS region this resource belongs to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`account\`Optional +##### \`account\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* the resource is in the same account as the stack it belongs to The AWS account ID this resource belongs to. --- -##### \`environment_from_arn\`Optional +##### \`environment_from_arn\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. ARN to deduce region and account from. @@ -61960,9 +64020,9 @@ The ARN is parsed and the account and region are taken from the ARN. This should --- -##### \`physical_name\`Optional +##### \`physical_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The physical name will be allocated by CloudFormation at deployment time The value passed in by users to the physical name prop of the resource. @@ -61971,33 +64031,33 @@ The value passed in by users to the physical name prop of the resource. --- -##### \`region\`Optional +##### \`region\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* the resource is in the same region as the stack it belongs to The AWS region this resource belongs to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to use the images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repository_uri_for_digest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -62005,13 +64065,13 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`python def grant( @@ -62020,19 +64080,19 @@ def grant( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`grant_pull\` +##### \`grant_pull\` \`\`\`python def grant_pull( @@ -62040,13 +64100,13 @@ def grant_pull( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grant_pull_push\` \`\`\`python def grant_pull_push( @@ -62054,13 +64114,13 @@ def grant_pull_push( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`on_cloud_trail_event\` \`\`\`python def on_cloud_trail_event( @@ -62072,55 +64132,55 @@ def on_cloud_trail_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_cloud_trail_image_pushed\` +##### \`on_cloud_trail_image_pushed\` \`\`\`python def on_cloud_trail_image_pushed( @@ -62133,64 +64193,64 @@ def on_cloud_trail_image_pushed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tag\`Optional +###### \`image_tag\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -##### \`on_event\` +##### \`on_event\` \`\`\`python def on_event( @@ -62202,53 +64262,53 @@ def on_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_image_scan_completed\` +##### \`on_image_scan_completed\` \`\`\`python def on_image_scan_completed( @@ -62261,57 +64321,57 @@ def on_image_scan_completed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tags\`Optional +###### \`image_tags\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -62320,7 +64380,7 @@ Leave it undefined to watch the full repository. --- -##### \`repository_uri_for_digest\` +##### \`repository_uri_for_digest\` \`\`\`python def repository_uri_for_digest( @@ -62328,15 +64388,15 @@ def repository_uri_for_digest( ) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* str Optional image digest. --- -##### \`repository_uri_for_tag\` +##### \`repository_uri_for_tag\` \`\`\`python def repository_uri_for_tag( @@ -62344,56 +64404,56 @@ def repository_uri_for_tag( ) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* str Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositorybasepropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrrepositorybasepropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrrepositorybasepropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -##### \`repository_uri\`Required +##### \`repository_uri\`Required \`\`\`python repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URI of this repository (represents the latest image):. @@ -62402,15 +64462,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62423,24 +64483,24 @@ aws_cdk.aws_ecr.CfnPublicRepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repository_catalog_data\`Optional +##### \`repository_catalog_data\`Optional \`\`\`python repository_catalog_data: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -62448,13 +64508,13 @@ repository_catalog_data: typing.Any --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -62462,13 +64522,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -62476,13 +64536,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::PublicRepository.Tags\`. @@ -62490,13 +64550,13 @@ tags: typing.List[CfnTag] --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62506,21 +64566,21 @@ aws_cdk.aws_ecr.CfnRegistryPolicyProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policy_text\`](#awscdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`typing.Any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policy_text\`Required +##### \`policy_text\`Required \`\`\`python policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -62528,13 +64588,13 @@ policy_text: typing.Any --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62544,21 +64604,21 @@ aws_cdk.aws_ecr.CfnReplicationConfigurationProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replication_configuration\`](#awscdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replication_configuration | typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replication_configuration\`Required +##### \`replication_configuration\`Required \`\`\`python replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, ReplicationConfigurationProperty] \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -62566,13 +64626,13 @@ replication_configuration: typing.Union[IResolvable, ReplicationConfigurationPro --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62588,27 +64648,27 @@ aws_cdk.aws_ecr.CfnRepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryption_configuration\`](#awscdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`image_scanning_configuration\`](#awscdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`typing.Any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`image_tag_mutability\`](#awscdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`str\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecycle_policy\`](#awscdkawsecrcfnrepositorypropspropertylifecyclepolicy) | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repository_name\`](#awscdkawsecrcfnrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryption_configuration\`Optional +##### \`encryption_configuration\`Optional \`\`\`python encryption_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -62616,13 +64676,13 @@ encryption_configuration: typing.Any --- -##### \`image_scanning_configuration\`Optional +##### \`image_scanning_configuration\`Optional \`\`\`python image_scanning_configuration: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -62630,13 +64690,13 @@ image_scanning_configuration: typing.Any --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.ImageTagMutability\`. @@ -62644,13 +64704,13 @@ image_tag_mutability: str --- -##### \`lifecycle_policy\`Optional +##### \`lifecycle_policy\`Optional \`\`\`python lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty\`](#aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty)] +- *Type:* typing.Union[aws_cdk.core.IResolvable, LifecyclePolicyProperty] \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -62658,13 +64718,13 @@ lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::Repository.RepositoryName\`. @@ -62672,13 +64732,13 @@ repository_name: str --- -##### \`repository_policy_text\`Optional +##### \`repository_policy_text\`Optional \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -62686,13 +64746,13 @@ repository_policy_text: typing.Any --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::Repository.Tags\`. @@ -62700,11 +64760,11 @@ tags: typing.List[CfnTag] --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62715,22 +64775,22 @@ aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecycle_policy_text\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registry_id\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`str\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecycle_policy_text | str | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registry_id | str | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecycle_policy_text\`Optional +##### \`lifecycle_policy_text\`Optional \`\`\`python lifecycle_policy_text: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -62738,13 +64798,13 @@ lifecycle_policy_text: str --- -##### \`registry_id\`Optional +##### \`registry_id\`Optional \`\`\`python registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -62752,11 +64812,11 @@ registry_id: str --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62771,39 +64831,39 @@ aws_cdk.aws_ecr.LifecycleRule( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecrlifecyclerulepropertydescription) | \`str\` | Describes the purpose of the rule. | -| [\`max_image_age\`](#awscdkawsecrlifecyclerulepropertymaximageage) | [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`max_image_count\`](#awscdkawsecrlifecyclerulepropertymaximagecount) | \`typing.Union[int, float]\` | The maximum number of images to retain. | -| [\`rule_priority\`](#awscdkawsecrlifecyclerulepropertyrulepriority) | \`typing.Union[int, float]\` | Controls the order in which rules are evaluated (low to high). | -| [\`tag_prefix_list\`](#awscdkawsecrlifecyclerulepropertytagprefixlist) | typing.List[\`str\`] | Select images that have ALL the given prefixes in their tag. | -| [\`tag_status\`](#awscdkawsecrlifecyclerulepropertytagstatus) | [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) | Select images based on tags. | +| description | str | Describes the purpose of the rule. | +| max_image_age | aws_cdk.core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| max_image_count | typing.Union[int, float] | The maximum number of images to retain. | +| rule_priority | typing.Union[int, float] | Controls the order in which rules are evaluated (low to high). | +| tag_prefix_list | typing.List[str] | Select images that have ALL the given prefixes in their tag. | +| tag_status | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description Describes the purpose of the rule. --- -##### \`max_image_age\`Optional +##### \`max_image_age\`Optional \`\`\`python max_image_age: Duration \`\`\` -- *Type:* [\`aws_cdk.core.Duration\`](#aws_cdk.core.Duration) +- *Type:* aws_cdk.core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -62811,13 +64871,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`max_image_count\`Optional +##### \`max_image_count\`Optional \`\`\`python max_image_count: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] The maximum number of images to retain. @@ -62825,13 +64885,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rule_priority\`Optional +##### \`rule_priority\`Optional \`\`\`python rule_priority: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -62840,13 +64900,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tag_prefix_list\`Optional +##### \`tag_prefix_list\`Optional \`\`\`python tag_prefix_list: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] Select images that have ALL the given prefixes in their tag. @@ -62854,13 +64914,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tag_status\`Optional +##### \`tag_status\`Optional \`\`\`python tag_status: TagStatus \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagStatus\`](#aws_cdk.aws_ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -62869,11 +64929,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62887,92 +64947,92 @@ aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tag\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`str\` | Only watch changes to this image tag. | +| description | str | A description of the rule's purpose. | +| event_pattern | aws_cdk.aws_events.EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | aws_cdk.aws_events.IRuleTarget | The target to register for the event. | +| image_tag | str | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`event_pattern\`Optional \`\`\`python event_pattern: EventPattern \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`rule_name\`Optional \`\`\`python rule_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`python target: IRuleTarget \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tag\`Optional +##### \`image_tag\`Optional \`\`\`python image_tag: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -62986,81 +65046,81 @@ aws_cdk.aws_ecr.OnImageScanCompletedOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecronimagescancompletedoptionspropertydescription) | \`str\` | A description of the rule's purpose. | -| [\`event_pattern\`](#awscdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`rule_name\`](#awscdkawsecronimagescancompletedoptionspropertyrulename) | \`str\` | A name for the rule. | -| [\`target\`](#awscdkawsecronimagescancompletedoptionspropertytarget) | [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) | The target to register for the event. | -| [\`image_tags\`](#awscdkawsecronimagescancompletedoptionspropertyimagetags) | typing.List[\`str\`] | Only watch changes to the image tags spedified. | +| description | str | A description of the rule's purpose. | +| event_pattern | aws_cdk.aws_events.EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | aws_cdk.aws_events.IRuleTarget | The target to register for the event. | +| image_tags | typing.List[str] | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`python description: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -##### \`event_pattern\`Optional +##### \`event_pattern\`Optional \`\`\`python event_pattern: EventPattern \`\`\` -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`rule_name\`Optional +##### \`rule_name\`Optional \`\`\`python rule_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`python target: IRuleTarget \`\`\` -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`image_tags\`Optional +##### \`image_tags\`Optional \`\`\`python image_tags: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -63069,11 +65129,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -63083,21 +65143,21 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#awscdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationRuleProperty]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required \`\`\`python rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty)]]] +- *Type:* typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationRuleProperty]]] \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -63105,11 +65165,11 @@ rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Replicati --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -63120,22 +65180,22 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registry_id\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`str\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registry_id | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required \`\`\`python region: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -63143,13 +65203,13 @@ region: str --- -##### \`registry_id\`Required +##### \`registry_id\`Required \`\`\`python registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -63157,11 +65217,11 @@ registry_id: str --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -63171,21 +65231,21 @@ aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#awscdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationDestinationProperty]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required \`\`\`python destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), typing.List[typing.Union[[\`aws_cdk.core.IResolvable\`](#aws_cdk.core.IResolvable), [\`aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)]]] +- *Type:* typing.Union[aws_cdk.core.IResolvable, typing.List[typing.Union[aws_cdk.core.IResolvable, ReplicationDestinationProperty]]] \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -63193,9 +65253,9 @@ destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, Re --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -63206,38 +65266,38 @@ aws_cdk.aws_ecr.RepositoryAttributes( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_arn\`](#awscdkawsecrrepositoryattributespropertyrepositoryarn)* | \`str\` | *No description.* | -| [\`repository_name\`](#awscdkawsecrrepositoryattributespropertyrepositoryname)* | \`str\` | *No description.* | +| repository_arn | str | *No description.* | +| repository_name | str | *No description.* | --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`python import aws_cdk.aws_ecr @@ -63252,39 +65312,39 @@ aws_cdk.aws_ecr.RepositoryProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`image_scan_on_push\`](#awscdkawsecrrepositorypropspropertyimagescanonpush) | \`bool\` | Enable the scan on push when creating the repository. | -| [\`image_tag_mutability\`](#awscdkawsecrrepositorypropspropertyimagetagmutability) | [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycle_registry_id\`](#awscdkawsecrrepositorypropspropertylifecycleregistryid) | \`str\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycle_rules\`](#awscdkawsecrrepositorypropspropertylifecyclerules) | typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] | Life cycle rules to apply to this registry. | -| [\`removal_policy\`](#awscdkawsecrrepositorypropspropertyremovalpolicy) | [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repository_name\`](#awscdkawsecrrepositorypropspropertyrepositoryname) | \`str\` | Name for this repository. | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | aws_cdk.core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | --- -##### \`image_scan_on_push\`Optional +##### \`image_scan_on_push\`Optional \`\`\`python image_scan_on_push: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Enable the scan on push when creating the repository. --- -##### \`image_tag_mutability\`Optional +##### \`image_tag_mutability\`Optional \`\`\`python image_tag_mutability: TagMutability \`\`\` -- *Type:* [\`aws_cdk.aws_ecr.TagMutability\`](#aws_cdk.aws_ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -63293,78 +65353,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycle_registry_id\`Optional +##### \`lifecycle_registry_id\`Optional \`\`\`python lifecycle_registry_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycle_rules\`Optional +##### \`lifecycle_rules\`Optional \`\`\`python lifecycle_rules: typing.List[LifecycleRule] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ecr.LifecycleRule\`](#aws_cdk.aws_ecr.LifecycleRule)] +- *Type:* typing.List[LifecycleRule] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removal_policy\`Optional +##### \`removal_policy\`Optional \`\`\`python removal_policy: RemovalPolicy \`\`\` -- *Type:* [\`aws_cdk.core.RemovalPolicy\`](#aws_cdk.core.RemovalPolicy) +- *Type:* aws_cdk.core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repository_name\`Optional +##### \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grant_read | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -63374,30 +65434,30 @@ aws_cdk.aws_ecr.AuthorizationToken.grant_read( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grant_read\`](#awscdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grant_read | Grant access to retrieve an authorization token. | --- -##### \`grant_read\` +##### \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -63407,42 +65467,42 @@ aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`aws_cdk.core.IResource\`](#aws_cdk.core.IResource) +- *Extends:* aws_cdk.core.IResource -- *Implemented By:* [\`aws_cdk.aws_ecr.Repository\`](#aws_cdk.aws_ecr.Repository), [\`aws_cdk.aws_ecr.RepositoryBase\`](#aws_cdk.aws_ecr.RepositoryBase), [\`aws_cdk.aws_ecr.IRepository\`](#aws_cdk.aws_ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to pull images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repository_uri_for_digest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`add_to_resource_policy\` +##### \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -63450,13 +65510,13 @@ def add_to_resource_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`python def grant( @@ -63465,19 +65525,19 @@ def grant( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`grant_pull\` +##### \`grant_pull\` \`\`\`python def grant_pull( @@ -63485,13 +65545,13 @@ def grant_pull( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`grant_pull_push\` +##### \`grant_pull_push\` \`\`\`python def grant_pull_push( @@ -63499,13 +65559,13 @@ def grant_pull_push( ) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -##### \`on_cloud_trail_event\` +##### \`on_cloud_trail_event\` \`\`\`python def on_cloud_trail_event( @@ -63517,55 +65577,55 @@ def on_cloud_trail_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_cloud_trail_image_pushed\` +##### \`on_cloud_trail_image_pushed\` \`\`\`python def on_cloud_trail_image_pushed( @@ -63578,64 +65638,64 @@ def on_cloud_trail_image_pushed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tag\`Optional +###### \`image_tag\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -##### \`on_event\` +##### \`on_event\` \`\`\`python def on_event( @@ -63647,53 +65707,53 @@ def on_event( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`on_image_scan_completed\` +##### \`on_image_scan_completed\` \`\`\`python def on_image_scan_completed( @@ -63706,57 +65766,57 @@ def on_image_scan_completed( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -###### \`description\`Optional +###### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -###### \`event_pattern\`Optional +###### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -###### \`rule_name\`Optional +###### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -###### \`target\`Optional +###### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -###### \`image_tags\`Optional +###### \`image_tags\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -63765,7 +65825,7 @@ Leave it undefined to watch the full repository. --- -##### \`repository_uri_for_digest\` +##### \`repository_uri_for_digest\` \`\`\`python def repository_uri_for_digest( @@ -63773,15 +65833,15 @@ def repository_uri_for_digest( ) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`str\` +- *Type:* str Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repository_uri_for_tag\` +##### \`repository_uri_for_tag\` \`\`\`python def repository_uri_for_tag( @@ -63789,46 +65849,46 @@ def repository_uri_for_tag( ) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`str\` +- *Type:* str Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) | The stack in which this resource is defined. | -| [\`repository_arn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| node | aws_cdk.core.ConstructNode | The construct tree node for this construct. | +| env | aws_cdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws_cdk.core.Stack | The stack in which this resource is defined. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`python node: ConstructNode \`\`\` -- *Type:* [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) +- *Type:* aws_cdk.core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`python env: ResourceEnvironment \`\`\` -- *Type:* [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) +- *Type:* aws_cdk.core.ResourceEnvironment The environment this resource belongs to. @@ -63836,49 +65896,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`python stack: Stack \`\`\` -- *Type:* [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) +- *Type:* aws_cdk.core.Stack The stack in which this resource is defined. --- -##### \`repository_arn\`Required +##### \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -##### \`repository_name\`Required +##### \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -##### \`repository_uri\`Required +##### \`repository_uri\`Required \`\`\`python repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URI of this repository (represents the latest image):. @@ -63886,60 +65946,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#awscdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#awscdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#awscdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -65162,15 +67222,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -65184,27 +67244,27 @@ aws_eks.AwsAuth( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksawsauthparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawseksawsauthparameterid)* | \`str\` | *No description.* | -| [\`cluster\`](#awscdkawseksawsauthpropsparametercluster)* | [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) | The EKS cluster to apply this configuration to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| cluster | Cluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply this configuration to. @@ -65212,18 +67272,18 @@ The EKS cluster to apply this configuration to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_account\`](#awscdkawseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`add_masters_role\`](#awscdkawseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`add_role_mapping\`](#awscdkawseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`add_user_mapping\`](#awscdkawseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| add_account | Additional AWS account to add to the aws-auth configmap. | +| add_masters_role | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| add_role_mapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| add_user_mapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`add_account\` +##### \`add_account\` \`\`\`python def add_account( @@ -65231,15 +67291,15 @@ def add_account( ) \`\`\` -###### \`account_id\`Required +###### \`account_id\`Required -- *Type:* \`str\` +- *Type:* str account number. --- -##### \`add_masters_role\` +##### \`add_masters_role\` \`\`\`python def add_masters_role( @@ -65248,23 +67308,23 @@ def add_masters_role( ) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole The IAM role to add. --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`str\` +- *Type:* str Optional user (defaults to the role ARN). --- -##### \`add_role_mapping\` +##### \`add_role_mapping\` \`\`\`python def add_role_mapping( @@ -65274,34 +67334,34 @@ def add_role_mapping( ) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole The IAM role to map. --- -###### \`groups\`Required +###### \`groups\`Required -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -##### \`add_user_mapping\` +##### \`add_user_mapping\` \`\`\`python def add_user_mapping( @@ -65311,27 +67371,27 @@ def add_user_mapping( ) \`\`\` -###### \`user\`Required +###### \`user\`Required -- *Type:* [\`aws_cdk.aws_iam.IUser\`](#aws_cdk.aws_iam.IUser) +- *Type:* aws_cdk.aws_iam.IUser The IAM user to map. --- -###### \`groups\`Required +###### \`groups\`Required -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. @@ -65341,15 +67401,15 @@ The user name within Kubernetes to map to the IAM role. -### CfnAddon +### CfnAddon -- *Implements:* [\`aws_cdk.IInspectable\`](#aws_cdk.IInspectable) +- *Implements:* aws_cdk.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -65368,36 +67428,36 @@ aws_eks.CfnAddon( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekscfnaddonparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsekscfnaddonparameterid)* | \`str\` | scoped id of the resource. | -| [\`addon_name\`](#awscdkawsekscfnaddonpropsparameteraddonname)* | \`str\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`cluster_name\`](#awscdkawsekscfnaddonpropsparameterclustername)* | \`str\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addon_version\`](#awscdkawsekscfnaddonpropsparameteraddonversion) | \`str\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolve_conflicts\`](#awscdkawsekscfnaddonpropsparameterresolveconflicts) | \`str\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`service_account_role_arn\`](#awscdkawsekscfnaddonpropsparameterserviceaccountrolearn) | \`str\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#awscdkawsekscfnaddonpropsparametertags) | typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] | \`AWS::EKS::Addon.Tags\`. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| addon_name | str | \`AWS::EKS::Addon.AddonName\`. | +| cluster_name | str | \`AWS::EKS::Addon.ClusterName\`. | +| addon_version | str | \`AWS::EKS::Addon.AddonVersion\`. | +| resolve_conflicts | str | \`AWS::EKS::Addon.ResolveConflicts\`. | +| service_account_role_arn | str | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | typing.List[aws_cdk.CfnTag] | \`AWS::EKS::Addon.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`addon_name\`Required +##### \`addon_name\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonName\`. @@ -65405,9 +67465,9 @@ scoped id of the resource. --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ClusterName\`. @@ -65415,9 +67475,9 @@ scoped id of the resource. --- -##### \`addon_version\`Optional +##### \`addon_version\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonVersion\`. @@ -65425,9 +67485,9 @@ scoped id of the resource. --- -##### \`resolve_conflicts\`Optional +##### \`resolve_conflicts\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ResolveConflicts\`. @@ -65435,9 +67495,9 @@ scoped id of the resource. --- -##### \`service_account_role_arn\`Optional +##### \`service_account_role_arn\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -65445,9 +67505,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] +- *Type:* typing.List[aws_cdk.CfnTag] \`AWS::EKS::Addon.Tags\`. @@ -65455,15 +67515,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -65471,46 +67531,46 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.TreeInspector\`](#aws_cdk.TreeInspector) +- *Type:* aws_cdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsekscfnaddonpropertyattrarn)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsekscfnaddonpropertytags)* | [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`addon_name\`](#awscdkawsekscfnaddonpropertyaddonname)* | \`str\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`cluster_name\`](#awscdkawsekscfnaddonpropertyclustername)* | \`str\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addon_version\`](#awscdkawsekscfnaddonpropertyaddonversion) | \`str\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolve_conflicts\`](#awscdkawsekscfnaddonpropertyresolveconflicts) | \`str\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`service_account_role_arn\`](#awscdkawsekscfnaddonpropertyserviceaccountrolearn) | \`str\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| attr_arn | str | *No description.* | +| tags | aws_cdk.TagManager | \`AWS::EKS::Addon.Tags\`. | +| addon_name | str | \`AWS::EKS::Addon.AddonName\`. | +| cluster_name | str | \`AWS::EKS::Addon.ClusterName\`. | +| addon_version | str | \`AWS::EKS::Addon.AddonVersion\`. | +| resolve_conflicts | str | \`AWS::EKS::Addon.ResolveConflicts\`. | +| service_account_role_arn | str | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) +- *Type:* aws_cdk.TagManager \`AWS::EKS::Addon.Tags\`. @@ -65518,13 +67578,13 @@ tags: TagManager --- -##### \`addon_name\`Required +##### \`addon_name\`Required \`\`\`python addon_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonName\`. @@ -65532,13 +67592,13 @@ addon_name: str --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ClusterName\`. @@ -65546,13 +67606,13 @@ cluster_name: str --- -##### \`addon_version\`Optional +##### \`addon_version\`Optional \`\`\`python addon_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonVersion\`. @@ -65560,13 +67620,13 @@ addon_version: str --- -##### \`resolve_conflicts\`Optional +##### \`resolve_conflicts\`Optional \`\`\`python resolve_conflicts: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ResolveConflicts\`. @@ -65574,13 +67634,13 @@ resolve_conflicts: str --- -##### \`service_account_role_arn\`Optional +##### \`service_account_role_arn\`Optional \`\`\`python service_account_role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -65588,31 +67648,35 @@ service_account_role_arn: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsekscfnaddonpropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`aws_cdk.IInspectable\`](#aws_cdk.IInspectable) +- *Implements:* aws_cdk.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -65631,36 +67695,36 @@ aws_eks.CfnCluster( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekscfnclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsekscfnclusterparameterid)* | \`str\` | scoped id of the resource. | -| [\`resources_vpc_config\`](#awscdkawsekscfnclusterpropsparameterresourcesvpcconfig)* | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`role_arn\`](#awscdkawsekscfnclusterpropsparameterrolearn)* | \`str\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryption_config\`](#awscdkawsekscfnclusterpropsparameterencryptionconfig) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetes_network_config\`](#awscdkawsekscfnclusterpropsparameterkubernetesnetworkconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#awscdkawsekscfnclusterpropsparametername) | \`str\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#awscdkawsekscfnclusterpropsparameterversion) | \`str\` | \`AWS::EKS::Cluster.Version\`. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| resources_vpc_config | typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| role_arn | str | \`AWS::EKS::Cluster.RoleArn\`. | +| encryption_config | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetes_network_config | typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | str | \`AWS::EKS::Cluster.Name\`. | +| version | str | \`AWS::EKS::Cluster.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`resources_vpc_config\`Required +##### \`resources_vpc_config\`Required -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -65668,9 +67732,9 @@ scoped id of the resource. --- -##### \`role_arn\`Required +##### \`role_arn\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.RoleArn\`. @@ -65678,9 +67742,9 @@ scoped id of the resource. --- -##### \`encryption_config\`Optional +##### \`encryption_config\`Optional -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -65688,9 +67752,9 @@ scoped id of the resource. --- -##### \`kubernetes_network_config\`Optional +##### \`kubernetes_network_config\`Optional -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -65698,9 +67762,9 @@ scoped id of the resource. --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Name\`. @@ -65708,9 +67772,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Version\`. @@ -65718,15 +67782,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -65734,101 +67798,101 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.TreeInspector\`](#aws_cdk.TreeInspector) +- *Type:* aws_cdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsekscfnclusterpropertyattrarn)* | \`str\` | *No description.* | -| [\`attr_certificate_authority_data\`](#awscdkawsekscfnclusterpropertyattrcertificateauthoritydata)* | \`str\` | *No description.* | -| [\`attr_cluster_security_group_id\`](#awscdkawsekscfnclusterpropertyattrclustersecuritygroupid)* | \`str\` | *No description.* | -| [\`attr_encryption_config_key_arn\`](#awscdkawsekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`str\` | *No description.* | -| [\`attr_endpoint\`](#awscdkawsekscfnclusterpropertyattrendpoint)* | \`str\` | *No description.* | -| [\`attr_open_id_connect_issuer_url\`](#awscdkawsekscfnclusterpropertyattropenidconnectissuerurl)* | \`str\` | *No description.* | -| [\`resources_vpc_config\`](#awscdkawsekscfnclusterpropertyresourcesvpcconfig)* | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`role_arn\`](#awscdkawsekscfnclusterpropertyrolearn)* | \`str\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryption_config\`](#awscdkawsekscfnclusterpropertyencryptionconfig) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetes_network_config\`](#awscdkawsekscfnclusterpropertykubernetesnetworkconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#awscdkawsekscfnclusterpropertyname) | \`str\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#awscdkawsekscfnclusterpropertyversion) | \`str\` | \`AWS::EKS::Cluster.Version\`. | +| attr_arn | str | *No description.* | +| attr_certificate_authority_data | str | *No description.* | +| attr_cluster_security_group_id | str | *No description.* | +| attr_encryption_config_key_arn | str | *No description.* | +| attr_endpoint | str | *No description.* | +| attr_open_id_connect_issuer_url | str | *No description.* | +| resources_vpc_config | typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| role_arn | str | \`AWS::EKS::Cluster.RoleArn\`. | +| encryption_config | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetes_network_config | typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | str | \`AWS::EKS::Cluster.Name\`. | +| version | str | \`AWS::EKS::Cluster.Version\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_certificate_authority_data\`Required +##### \`attr_certificate_authority_data\`Required \`\`\`python attr_certificate_authority_data: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_cluster_security_group_id\`Required +##### \`attr_cluster_security_group_id\`Required \`\`\`python attr_cluster_security_group_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_encryption_config_key_arn\`Required +##### \`attr_encryption_config_key_arn\`Required \`\`\`python attr_encryption_config_key_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_endpoint\`Required +##### \`attr_endpoint\`Required \`\`\`python attr_endpoint: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_open_id_connect_issuer_url\`Required +##### \`attr_open_id_connect_issuer_url\`Required \`\`\`python attr_open_id_connect_issuer_url: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`resources_vpc_config\`Required +##### \`resources_vpc_config\`Required \`\`\`python resources_vpc_config: typing.Union[ResourcesVpcConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -65836,13 +67900,13 @@ resources_vpc_config: typing.Union[ResourcesVpcConfigProperty, IResolvable] --- -##### \`role_arn\`Required +##### \`role_arn\`Required \`\`\`python role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.RoleArn\`. @@ -65850,13 +67914,13 @@ role_arn: str --- -##### \`encryption_config\`Optional +##### \`encryption_config\`Optional \`\`\`python encryption_config: typing.Union[IResolvable, typing.List[typing.Union[EncryptionConfigProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -65864,13 +67928,13 @@ encryption_config: typing.Union[IResolvable, typing.List[typing.Union[Encryption --- -##### \`kubernetes_network_config\`Optional +##### \`kubernetes_network_config\`Optional \`\`\`python kubernetes_network_config: typing.Union[KubernetesNetworkConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -65878,13 +67942,13 @@ kubernetes_network_config: typing.Union[KubernetesNetworkConfigProperty, IResolv --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`python name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Name\`. @@ -65892,13 +67956,13 @@ name: str --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Version\`. @@ -65906,31 +67970,35 @@ version: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsekscfnclusterpropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`aws_cdk.IInspectable\`](#aws_cdk.IInspectable) +- *Implements:* aws_cdk.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -65949,36 +68017,36 @@ aws_eks.CfnFargateProfile( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekscfnfargateprofileparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsekscfnfargateprofileparameterid)* | \`str\` | scoped id of the resource. | -| [\`cluster_name\`](#awscdkawsekscfnfargateprofilepropsparameterclustername)* | \`str\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`pod_execution_role_arn\`](#awscdkawsekscfnfargateprofilepropsparameterpodexecutionrolearn)* | \`str\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#awscdkawsekscfnfargateprofilepropsparameterselectors)* | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargate_profile_name\`](#awscdkawsekscfnfargateprofilepropsparameterfargateprofilename) | \`str\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#awscdkawsekscfnfargateprofilepropsparametersubnets) | typing.List[\`str\`] | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#awscdkawsekscfnfargateprofilepropsparametertags) | typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] | \`AWS::EKS::FargateProfile.Tags\`. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| cluster_name | str | \`AWS::EKS::FargateProfile.ClusterName\`. | +| pod_execution_role_arn | str | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargate_profile_name | str | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | typing.List[str] | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | typing.List[aws_cdk.CfnTag] | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.ClusterName\`. @@ -65986,9 +68054,9 @@ scoped id of the resource. --- -##### \`pod_execution_role_arn\`Required +##### \`pod_execution_role_arn\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -65996,9 +68064,9 @@ scoped id of the resource. --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] \`AWS::EKS::FargateProfile.Selectors\`. @@ -66006,9 +68074,9 @@ scoped id of the resource. --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -66016,9 +68084,9 @@ scoped id of the resource. --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::FargateProfile.Subnets\`. @@ -66026,9 +68094,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] +- *Type:* typing.List[aws_cdk.CfnTag] \`AWS::EKS::FargateProfile.Tags\`. @@ -66036,15 +68104,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -66052,46 +68120,46 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.TreeInspector\`](#aws_cdk.TreeInspector) +- *Type:* aws_cdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsekscfnfargateprofilepropertyattrarn)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsekscfnfargateprofilepropertytags)* | [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`cluster_name\`](#awscdkawsekscfnfargateprofilepropertyclustername)* | \`str\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`pod_execution_role_arn\`](#awscdkawsekscfnfargateprofilepropertypodexecutionrolearn)* | \`str\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#awscdkawsekscfnfargateprofilepropertyselectors)* | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargate_profile_name\`](#awscdkawsekscfnfargateprofilepropertyfargateprofilename) | \`str\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#awscdkawsekscfnfargateprofilepropertysubnets) | typing.List[\`str\`] | \`AWS::EKS::FargateProfile.Subnets\`. | +| attr_arn | str | *No description.* | +| tags | aws_cdk.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| cluster_name | str | \`AWS::EKS::FargateProfile.ClusterName\`. | +| pod_execution_role_arn | str | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargate_profile_name | str | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | typing.List[str] | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) +- *Type:* aws_cdk.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -66099,13 +68167,13 @@ tags: TagManager --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.ClusterName\`. @@ -66113,13 +68181,13 @@ cluster_name: str --- -##### \`pod_execution_role_arn\`Required +##### \`pod_execution_role_arn\`Required \`\`\`python pod_execution_role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -66127,13 +68195,13 @@ pod_execution_role_arn: str --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`python selectors: typing.Union[IResolvable, typing.List[typing.Union[SelectorProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] \`AWS::EKS::FargateProfile.Selectors\`. @@ -66141,13 +68209,13 @@ selectors: typing.Union[IResolvable, typing.List[typing.Union[SelectorProperty, --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional \`\`\`python fargate_profile_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -66155,13 +68223,13 @@ fargate_profile_name: str --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`python subnets: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::FargateProfile.Subnets\`. @@ -66169,31 +68237,35 @@ subnets: typing.List[str] --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsekscfnfargateprofilepropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`str\` +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`aws_cdk.IInspectable\`](#aws_cdk.IInspectable) +- *Implements:* aws_cdk.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -66223,47 +68295,47 @@ aws_eks.CfnNodegroup( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekscfnnodegroupparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsekscfnnodegroupparameterid)* | \`str\` | scoped id of the resource. | -| [\`cluster_name\`](#awscdkawsekscfnnodegrouppropsparameterclustername)* | \`str\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`node_role\`](#awscdkawsekscfnnodegrouppropsparameternoderole)* | \`str\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#awscdkawsekscfnnodegrouppropsparametersubnets)* | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`ami_type\`](#awscdkawsekscfnnodegrouppropsparameteramitype) | \`str\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacity_type\`](#awscdkawsekscfnnodegrouppropsparametercapacitytype) | \`str\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`disk_size\`](#awscdkawsekscfnnodegrouppropsparameterdisksize) | \`typing.Union[int, float]\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`force_update_enabled\`](#awscdkawsekscfnnodegrouppropsparameterforceupdateenabled) | typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instance_types\`](#awscdkawsekscfnnodegrouppropsparameterinstancetypes) | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#awscdkawsekscfnnodegrouppropsparameterlabels) | \`typing.Any\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launch_template\`](#awscdkawsekscfnnodegrouppropsparameterlaunchtemplate) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroup_name\`](#awscdkawsekscfnnodegrouppropsparameternodegroupname) | \`str\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`release_version\`](#awscdkawsekscfnnodegrouppropsparameterreleaseversion) | \`str\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remote_access\`](#awscdkawsekscfnnodegrouppropsparameterremoteaccess) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scaling_config\`](#awscdkawsekscfnnodegrouppropsparameterscalingconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#awscdkawsekscfnnodegrouppropsparametertags) | \`typing.Any\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#awscdkawsekscfnnodegrouppropsparametertaints) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#awscdkawsekscfnnodegrouppropsparameterversion) | \`str\` | \`AWS::EKS::Nodegroup.Version\`. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| cluster_name | str | \`AWS::EKS::Nodegroup.ClusterName\`. | +| node_role | str | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | typing.List[str] | \`AWS::EKS::Nodegroup.Subnets\`. | +| ami_type | str | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacity_type | str | \`AWS::EKS::Nodegroup.CapacityType\`. | +| disk_size | typing.Union[int, float] | \`AWS::EKS::Nodegroup.DiskSize\`. | +| force_update_enabled | typing.Union[bool, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instance_types | typing.List[str] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | typing.Any | \`AWS::EKS::Nodegroup.Labels\`. | +| launch_template | typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroup_name | str | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| release_version | str | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remote_access | typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scaling_config | typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | typing.Any | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Nodegroup.Taints\`. | +| version | str | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ClusterName\`. @@ -66271,9 +68343,9 @@ scoped id of the resource. --- -##### \`node_role\`Required +##### \`node_role\`Required -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodeRole\`. @@ -66281,9 +68353,9 @@ scoped id of the resource. --- -##### \`subnets\`Required +##### \`subnets\`Required -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.Subnets\`. @@ -66291,9 +68363,9 @@ scoped id of the resource. --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.AmiType\`. @@ -66301,9 +68373,9 @@ scoped id of the resource. --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.CapacityType\`. @@ -66311,9 +68383,9 @@ scoped id of the resource. --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`AWS::EKS::Nodegroup.DiskSize\`. @@ -66321,9 +68393,9 @@ scoped id of the resource. --- -##### \`force_update_enabled\`Optional +##### \`force_update_enabled\`Optional -- *Type:* typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[bool, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -66331,9 +68403,9 @@ scoped id of the resource. --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -66341,9 +68413,9 @@ scoped id of the resource. --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::EKS::Nodegroup.Labels\`. @@ -66351,9 +68423,9 @@ scoped id of the resource. --- -##### \`launch_template\`Optional +##### \`launch_template\`Optional -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -66361,9 +68433,9 @@ scoped id of the resource. --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -66371,9 +68443,9 @@ scoped id of the resource. --- -##### \`release_version\`Optional +##### \`release_version\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -66381,9 +68453,9 @@ scoped id of the resource. --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -66391,9 +68463,9 @@ scoped id of the resource. --- -##### \`scaling_config\`Optional +##### \`scaling_config\`Optional -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -66401,9 +68473,9 @@ scoped id of the resource. --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::EKS::Nodegroup.Tags\`. @@ -66411,9 +68483,9 @@ scoped id of the resource. --- -##### \`taints\`Optional +##### \`taints\`Optional -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Nodegroup.Taints\`. @@ -66421,9 +68493,9 @@ scoped id of the resource. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.Version\`. @@ -66431,15 +68503,15 @@ scoped id of the resource. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`python def inspect( @@ -66447,79 +68519,79 @@ def inspect( ) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws_cdk.TreeInspector\`](#aws_cdk.TreeInspector) +- *Type:* aws_cdk.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attr_arn\`](#awscdkawsekscfnnodegrouppropertyattrarn)* | \`str\` | *No description.* | -| [\`attr_cluster_name\`](#awscdkawsekscfnnodegrouppropertyattrclustername)* | \`str\` | *No description.* | -| [\`attr_nodegroup_name\`](#awscdkawsekscfnnodegrouppropertyattrnodegroupname)* | \`str\` | *No description.* | -| [\`tags\`](#awscdkawsekscfnnodegrouppropertytags)* | [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`cluster_name\`](#awscdkawsekscfnnodegrouppropertyclustername)* | \`str\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`labels\`](#awscdkawsekscfnnodegrouppropertylabels)* | \`typing.Any\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`node_role\`](#awscdkawsekscfnnodegrouppropertynoderole)* | \`str\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#awscdkawsekscfnnodegrouppropertysubnets)* | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`ami_type\`](#awscdkawsekscfnnodegrouppropertyamitype) | \`str\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacity_type\`](#awscdkawsekscfnnodegrouppropertycapacitytype) | \`str\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`disk_size\`](#awscdkawsekscfnnodegrouppropertydisksize) | \`typing.Union[int, float]\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`force_update_enabled\`](#awscdkawsekscfnnodegrouppropertyforceupdateenabled) | typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instance_types\`](#awscdkawsekscfnnodegrouppropertyinstancetypes) | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`launch_template\`](#awscdkawsekscfnnodegrouppropertylaunchtemplate) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroup_name\`](#awscdkawsekscfnnodegrouppropertynodegroupname) | \`str\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`release_version\`](#awscdkawsekscfnnodegrouppropertyreleaseversion) | \`str\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remote_access\`](#awscdkawsekscfnnodegrouppropertyremoteaccess) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scaling_config\`](#awscdkawsekscfnnodegrouppropertyscalingconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`taints\`](#awscdkawsekscfnnodegrouppropertytaints) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#awscdkawsekscfnnodegrouppropertyversion) | \`str\` | \`AWS::EKS::Nodegroup.Version\`. | +| attr_arn | str | *No description.* | +| attr_cluster_name | str | *No description.* | +| attr_nodegroup_name | str | *No description.* | +| tags | aws_cdk.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| cluster_name | str | \`AWS::EKS::Nodegroup.ClusterName\`. | +| labels | typing.Any | \`AWS::EKS::Nodegroup.Labels\`. | +| node_role | str | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | typing.List[str] | \`AWS::EKS::Nodegroup.Subnets\`. | +| ami_type | str | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacity_type | str | \`AWS::EKS::Nodegroup.CapacityType\`. | +| disk_size | typing.Union[int, float] | \`AWS::EKS::Nodegroup.DiskSize\`. | +| force_update_enabled | typing.Union[bool, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instance_types | typing.List[str] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| launch_template | typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroup_name | str | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| release_version | str | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remote_access | typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scaling_config | typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| taints | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Nodegroup.Taints\`. | +| version | str | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`attr_arn\`Required +##### \`attr_arn\`Required \`\`\`python attr_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_cluster_name\`Required +##### \`attr_cluster_name\`Required \`\`\`python attr_cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`attr_nodegroup_name\`Required +##### \`attr_nodegroup_name\`Required \`\`\`python attr_nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) +- *Type:* aws_cdk.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -66527,13 +68599,13 @@ tags: TagManager --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ClusterName\`. @@ -66541,13 +68613,13 @@ cluster_name: str --- -##### \`labels\`Required +##### \`labels\`Required \`\`\`python labels: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::EKS::Nodegroup.Labels\`. @@ -66555,13 +68627,13 @@ labels: typing.Any --- -##### \`node_role\`Required +##### \`node_role\`Required \`\`\`python node_role: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodeRole\`. @@ -66569,13 +68641,13 @@ node_role: str --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`python subnets: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.Subnets\`. @@ -66583,13 +68655,13 @@ subnets: typing.List[str] --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional \`\`\`python ami_type: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.AmiType\`. @@ -66597,13 +68669,13 @@ ami_type: str --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional \`\`\`python capacity_type: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.CapacityType\`. @@ -66611,13 +68683,13 @@ capacity_type: str --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional \`\`\`python disk_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`AWS::EKS::Nodegroup.DiskSize\`. @@ -66625,13 +68697,13 @@ disk_size: typing.Union[int, float] --- -##### \`force_update_enabled\`Optional +##### \`force_update_enabled\`Optional \`\`\`python force_update_enabled: typing.Union[bool, IResolvable] \`\`\` -- *Type:* typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[bool, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -66639,13 +68711,13 @@ force_update_enabled: typing.Union[bool, IResolvable] --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional \`\`\`python instance_types: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -66653,13 +68725,13 @@ instance_types: typing.List[str] --- -##### \`launch_template\`Optional +##### \`launch_template\`Optional \`\`\`python launch_template: typing.Union[LaunchTemplateSpecificationProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -66667,13 +68739,13 @@ launch_template: typing.Union[LaunchTemplateSpecificationProperty, IResolvable] --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -66681,13 +68753,13 @@ nodegroup_name: str --- -##### \`release_version\`Optional +##### \`release_version\`Optional \`\`\`python release_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -66695,13 +68767,13 @@ release_version: str --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional \`\`\`python remote_access: typing.Union[RemoteAccessProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -66709,13 +68781,13 @@ remote_access: typing.Union[RemoteAccessProperty, IResolvable] --- -##### \`scaling_config\`Optional +##### \`scaling_config\`Optional \`\`\`python scaling_config: typing.Union[ScalingConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -66723,13 +68795,13 @@ scaling_config: typing.Union[ScalingConfigProperty, IResolvable] --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`python taints: typing.Union[IResolvable, typing.List[typing.Union[TaintProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Nodegroup.Taints\`. @@ -66737,13 +68809,13 @@ taints: typing.Union[IResolvable, typing.List[typing.Union[TaintProperty, IResol --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.Version\`. @@ -66751,31 +68823,35 @@ version: str --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsekscfnnodegrouppropertycfnresourcetypename)* | \`str\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Implements:* ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -66810,78 +68886,78 @@ aws_eks.Cluster( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`id\`](#awscdkawseksclusterparameterid)* | \`str\` | the id of the Construct to create. | -| [\`version\`](#awscdkawseksclusterpropsparameterversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawseksclusterpropsparameterclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawseksclusterpropsparameteroutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawseksclusterpropsparameteroutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawseksclusterpropsparameterrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawseksclusterpropsparametersecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawseksclusterpropsparametervpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawseksclusterpropsparametervpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | -| [\`cluster_handler_environment\`](#awscdkawseksclusterpropsparameterclusterhandlerenvironment) | typing.Mapping[\`str\`] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`core_dns_compute_type\`](#awscdkawseksclusterpropsparametercorednscomputetype) | [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpoint_access\`](#awscdkawseksclusterpropsparameterendpointaccess) | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectl_environment\`](#awscdkawseksclusterpropsparameterkubectlenvironment) | typing.Mapping[\`str\`] | Environment variables for the kubectl execution. | -| [\`kubectl_layer\`](#awscdkawseksclusterpropsparameterkubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksclusterpropsparameterkubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`masters_role\`](#awscdkawseksclusterpropsparametermastersrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`output_masters_role_arn\`](#awscdkawseksclusterpropsparameteroutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`place_cluster_handler_in_vpc\`](#awscdkawseksclusterpropsparameterplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdkawseksclusterpropsparameterprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secrets_encryption_key\`](#awscdkawseksclusterpropsparametersecretsencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`default_capacity\`](#awscdkawseksclusterpropsparameterdefaultcapacity) | \`typing.Union[int, float]\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`default_capacity_instance\`](#awscdkawseksclusterpropsparameterdefaultcapacityinstance) | [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`default_capacity_type\`](#awscdkawseksclusterpropsparameterdefaultcapacitytype) | [\`aws_cdk.aws_eks.DefaultCapacityType\`](#aws_cdk.aws_eks.DefaultCapacityType) | The default capacity type for the cluster. | +| scope | constructs.Construct | a Construct, most likely a cdk.Stack created. | +| id | str | the id of the Construct to create. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | +| cluster_handler_environment | typing.Mapping[str] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| core_dns_compute_type | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpoint_access | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectl_environment | typing.Mapping[str] | Environment variables for the kubectl execution. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| masters_role | aws_cdk.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| output_masters_role_arn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| place_cluster_handler_in_vpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secrets_encryption_key | aws_cdk.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| default_capacity | typing.Union[int, float] | Number of instances to allocate as an initial capacity for this cluster. | +| default_capacity_instance | aws_cdk.aws_ec2.InstanceType | The instance type to use for the default capacity. | +| default_capacity_type | DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str the id of the Construct to create. --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -66890,36 +68966,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -66928,38 +69004,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`cluster_handler_environment\`Optional +##### \`cluster_handler_environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`core_dns_compute_type\`Optional +##### \`core_dns_compute_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpoint_access\`Optional +##### \`endpoint_access\`Optional -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -66968,60 +69044,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`python # Example automatically generated from non-compiling source. May contain errors. layer = lambda_.LayerVersion(self, \\"kubectl-layer\\", code=lambda_.Code.from_asset(f\\"{__dirname}/layer.zip\\") )# compatible_runtimes: [lambda.Runtime.PROVIDED] \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`masters_role\`Optional +##### \`masters_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`output_masters_role_arn\`Optional +##### \`output_masters_role_arn\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`place_cluster_handler_in_vpc\`Optional +##### \`place_cluster_handler_in_vpc\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -67030,18 +69106,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secrets_encryption_key\`Optional +##### \`secrets_encryption_key\`Optional -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`default_capacity\`Optional +##### \`default_capacity\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -67050,9 +69126,9 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`default_capacity_instance\`Optional +##### \`default_capacity_instance\`Optional -- *Type:* [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) +- *Type:* aws_cdk.aws_ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -67061,32 +69137,32 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`default_capacity_type\`Optional +##### \`default_capacity_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.DefaultCapacityType\`](#aws_cdk.aws_eks.DefaultCapacityType) +- *Type:* DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_auto_scaling_group_capacity\`](#awscdkawseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`add_cdk8s_chart\`](#awscdkawseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`add_fargate_profile\`](#awscdkawseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`add_helm_chart\`](#awscdkawseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`add_manifest\`](#awscdkawseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`add_nodegroup_capacity\`](#awscdkawseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`add_service_account\`](#awscdkawseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`connect_auto_scaling_group_capacity\`](#awscdkawseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`get_service_load_balancer_address\`](#awscdkawseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| add_auto_scaling_group_capacity | Add nodes to this EKS cluster. | +| add_cdk8s_chart | Defines a CDK8s chart in this cluster. | +| add_fargate_profile | Adds a Fargate profile to this cluster. | +| add_helm_chart | Defines a Helm chart in this cluster. | +| add_manifest | Defines a Kubernetes resource in this cluster. | +| add_nodegroup_capacity | Add managed nodegroup to this Amazon EKS cluster. | +| add_service_account | Creates a new service account with corresponding IAM Role (IRSA). | +| connect_auto_scaling_group_capacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| get_service_load_balancer_address | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`add_auto_scaling_group_capacity\` +##### \`add_auto_scaling_group_capacity\` \`\`\`python def add_auto_scaling_group_capacity( @@ -67120,33 +69196,33 @@ def add_auto_scaling_group_capacity( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`allow_all_outbound\`Optional +###### \`allow_all_outbound\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -###### \`associate_public_ip_address\`Optional +###### \`associate_public_ip_address\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -###### \`auto_scaling_group_name\`Optional +###### \`auto_scaling_group_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -67155,44 +69231,44 @@ This name must be unique per Region per account. --- -###### \`block_devices\`Optional +###### \`block_devices\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.BlockDevice\`](#aws_cdk.aws_autoscaling.BlockDevice)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.BlockDevice] - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -###### \`cooldown\`Optional +###### \`cooldown\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -###### \`desired_capacity\`Optional +###### \`desired_capacity\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -###### \`group_metrics\`Optional +###### \`group_metrics\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.GroupMetrics\`](#aws_cdk.aws_autoscaling.GroupMetrics)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.GroupMetrics] - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -67201,18 +69277,18 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -###### \`health_check\`Optional +###### \`health_check\`Optional -- *Type:* [\`aws_cdk.aws_autoscaling.HealthCheck\`](#aws_cdk.aws_autoscaling.HealthCheck) +- *Type:* aws_cdk.aws_autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -###### \`ignore_unmodified_size_properties\`Optional +###### \`ignore_unmodified_size_properties\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -67221,62 +69297,62 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -###### \`instance_monitoring\`Optional +###### \`instance_monitoring\`Optional -- *Type:* [\`aws_cdk.aws_autoscaling.Monitoring\`](#aws_cdk.aws_autoscaling.Monitoring) +- *Type:* aws_cdk.aws_autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -###### \`key_name\`Optional +###### \`key_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -###### \`max_capacity\`Optional +###### \`max_capacity\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -###### \`max_instance_lifetime\`Optional +###### \`max_instance_lifetime\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -###### \`min_capacity\`Optional +###### \`min_capacity\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 Minimum number of instances in the fleet. --- -###### \`new_instances_protected_from_scale_in\`Optional +###### \`new_instances_protected_from_scale_in\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -67285,20 +69361,20 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -###### \`notifications\`Optional +###### \`notifications\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.NotificationConfiguration\`](#aws_cdk.aws_autoscaling.NotificationConfiguration)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.NotificationConfiguration] - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -###### \`signals\`Optional +###### \`signals\`Optional -- *Type:* [\`aws_cdk.aws_autoscaling.Signals\`](#aws_cdk.aws_autoscaling.Signals) +- *Type:* aws_cdk.aws_autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -67307,9 +69383,9 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -###### \`spot_price\`Optional +###### \`spot_price\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -67318,9 +69394,9 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -###### \`update_policy\`Optional +###### \`update_policy\`Optional -- *Type:* [\`aws_cdk.aws_autoscaling.UpdatePolicy\`](#aws_cdk.aws_autoscaling.UpdatePolicy) +- *Type:* aws_cdk.aws_autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -67329,26 +69405,26 @@ This is applied when any of the settings on the ASG are changed that affect how --- -###### \`vpc_subnets\`Optional +###### \`vpc_subnets\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -###### \`instance_type\`Required +###### \`instance_type\`Required -- *Type:* [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) +- *Type:* aws_cdk.aws_ec2.InstanceType Instance type of the instances to start. --- -###### \`bootstrap_enabled\`Optional +###### \`bootstrap_enabled\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -67357,27 +69433,27 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -###### \`bootstrap_options\`Optional +###### \`bootstrap_options\`Optional -- *Type:* [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -###### \`machine_image_type\`Optional +###### \`machine_image_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -###### \`map_role\`Optional +###### \`map_role\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -67386,9 +69462,9 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -###### \`spot_interrupt_handler\`Optional +###### \`spot_interrupt_handler\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -67397,7 +69473,7 @@ Only relevant if \`spotPrice\` is used. --- -##### \`add_cdk8s_chart\` +##### \`add_cdk8s_chart\` \`\`\`python def add_cdk8s_chart( @@ -67406,23 +69482,23 @@ def add_cdk8s_chart( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the cdk8s chart. --- -##### \`add_fargate_profile\` +##### \`add_fargate_profile\` \`\`\`python def add_fargate_profile( @@ -67435,17 +69511,17 @@ def add_fargate_profile( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str the id of this profile. --- -###### \`selectors\`Required +###### \`selectors\`Required -- *Type:* typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] +- *Type:* typing.List[Selector] The selectors to match for pods to use this Fargate profile. @@ -67453,31 +69529,31 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -###### \`fargate_profile_name\`Optional +###### \`fargate_profile_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* generated The name of the Fargate profile. --- -###### \`pod_execution_role\`Optional +###### \`pod_execution_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -###### \`subnet_selection\`Optional +###### \`subnet_selection\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -67486,9 +69562,9 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -###### \`vpc\`Optional +###### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -67497,7 +69573,7 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`add_helm_chart\` +##### \`add_helm_chart\` \`\`\`python def add_helm_chart( @@ -67514,52 +69590,52 @@ def add_helm_chart( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* \`str\` +- *Type:* str The name of the chart. --- -###### \`create_namespace\`Optional +###### \`create_namespace\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -###### \`namespace\`Optional +###### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* default The Kubernetes namespace scope of the requests. --- -###### \`release\`Optional +###### \`release\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -###### \`repository\`Optional +###### \`repository\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -67568,9 +69644,9 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -###### \`timeout\`Optional +###### \`timeout\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -67579,34 +69655,34 @@ Maximum 15 minutes. --- -###### \`values\`Optional +###### \`values\`Optional -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No values are provided to the chart. The values to be used by the chart. --- -###### \`version\`Optional +###### \`version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -###### \`wait\`Optional +###### \`wait\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`add_manifest\` +##### \`add_manifest\` \`\`\`python def add_manifest( @@ -67615,23 +69691,23 @@ def add_manifest( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] a list of Kubernetes resource specifications. --- -##### \`add_nodegroup_capacity\` +##### \`add_nodegroup_capacity\` \`\`\`python def add_nodegroup_capacity( @@ -67655,35 +69731,35 @@ def add_nodegroup_capacity( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str The ID of the nodegroup. --- -###### \`ami_type\`Optional +###### \`ami_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -###### \`capacity_type\`Optional +###### \`capacity_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -###### \`desired_size\`Optional +###### \`desired_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -67692,18 +69768,18 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -###### \`disk_size\`Optional +###### \`disk_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -###### \`force_update\`Optional +###### \`force_update\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -67712,40 +69788,40 @@ If an update fails because pods could not be drained, you can force the update a --- -###### \`instance_types\`Optional +###### \`instance_types\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] +- *Type:* typing.List[aws_cdk.aws_ec2.InstanceType] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -###### \`labels\`Optional +###### \`labels\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -###### \`launch_template_spec\`Optional +###### \`launch_template_spec\`Optional -- *Type:* [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -###### \`max_size\`Optional +###### \`max_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -67754,9 +69830,9 @@ Managed node groups can support up to 100 nodes by default. --- -###### \`min_size\`Optional +###### \`min_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -67765,18 +69841,18 @@ This number must be greater than zero. --- -###### \`nodegroup_name\`Optional +###### \`nodegroup_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* resource ID Name of the Nodegroup. --- -###### \`node_role\`Optional +###### \`node_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -67785,18 +69861,18 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -###### \`release_version\`Optional +###### \`release_version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -###### \`remote_access\`Optional +###### \`remote_access\`Optional -- *Type:* [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -67805,9 +69881,9 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -###### \`subnets\`Optional +###### \`subnets\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -67816,9 +69892,9 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -###### \`tags\`Optional +###### \`tags\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -67827,7 +69903,7 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`add_service_account\` +##### \`add_service_account\` \`\`\`python def add_service_account( @@ -67837,31 +69913,31 @@ def add_service_account( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`name\`Optional +###### \`name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -###### \`namespace\`Optional +###### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The namespace of the service account. --- -##### \`connect_auto_scaling_group_capacity\` +##### \`connect_auto_scaling_group_capacity\` \`\`\`python def connect_auto_scaling_group_capacity( @@ -67874,17 +69950,17 @@ def connect_auto_scaling_group_capacity( ) \`\`\` -###### \`auto_scaling_group\`Required +###### \`auto_scaling_group\`Required -- *Type:* [\`aws_cdk.aws_autoscaling.AutoScalingGroup\`](#aws_cdk.aws_autoscaling.AutoScalingGroup) +- *Type:* aws_cdk.aws_autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`bootstrap_enabled\`Optional +###### \`bootstrap_enabled\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -67893,27 +69969,27 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -###### \`bootstrap_options\`Optional +###### \`bootstrap_options\`Optional -- *Type:* [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -###### \`machine_image_type\`Optional +###### \`machine_image_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -###### \`map_role\`Optional +###### \`map_role\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -67922,9 +69998,9 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -###### \`spot_interrupt_handler\`Optional +###### \`spot_interrupt_handler\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -67933,7 +70009,7 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -##### \`get_service_load_balancer_address\` +##### \`get_service_load_balancer_address\` \`\`\`python def get_service_load_balancer_address( @@ -67943,41 +70019,41 @@ def get_service_load_balancer_address( ) \`\`\` -###### \`service_name\`Required +###### \`service_name\`Required -- *Type:* \`str\` +- *Type:* str The name of the service. --- -###### \`namespace\`Optional +###### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* 'default' The namespace the service belongs to. --- -###### \`timeout\`Optional +###### \`timeout\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`from_cluster_attributes\`](#awscdkawseksclusterfromclusterattributes) | Import an existing cluster. | +| from_cluster_attributes | Import an existing cluster. | --- -##### \`from_cluster_attributes\` +##### \`from_cluster_attributes\` \`\`\`python from aws_cdk import aws_eks @@ -68003,78 +70079,78 @@ aws_eks.Cluster.from_cluster_attributes( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the construct scope, in most cases 'this'. --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str the id or name to import as. --- -###### \`cluster_name\`Required +###### \`cluster_name\`Required -- *Type:* \`str\` +- *Type:* str The physical name of the Cluster. --- -###### \`cluster_certificate_authority_data\`Optional +###### \`cluster_certificate_authority_data\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -###### \`cluster_encryption_config_key_arn\`Optional +###### \`cluster_encryption_config_key_arn\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -###### \`cluster_endpoint\`Optional +###### \`cluster_endpoint\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -###### \`cluster_security_group_id\`Optional +###### \`cluster_security_group_id\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -###### \`kubectl_environment\`Optional +###### \`kubectl_environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -###### \`kubectl_layer\`Optional +###### \`kubectl_layer\`Optional -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -68083,18 +70159,18 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -###### \`kubectl_memory\`Optional +###### \`kubectl_memory\`Optional -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -###### \`kubectl_private_subnet_ids\`Optional +###### \`kubectl_private_subnet_ids\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -68103,18 +70179,18 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -###### \`kubectl_role_arn\`Optional +###### \`kubectl_role_arn\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -###### \`kubectl_security_group_id\`Optional +###### \`kubectl_security_group_id\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -68123,9 +70199,9 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -###### \`open_id_connect_provider\`Optional +###### \`open_id_connect_provider\`Optional -- *Type:* [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) +- *Type:* aws_cdk.aws_iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -68134,9 +70210,9 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -###### \`prune\`Optional +###### \`prune\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -68145,62 +70221,62 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -###### \`security_group_ids\`Optional +###### \`security_group_ids\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -###### \`vpc\`Optional +###### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`admin_role\`](#awscdkawseksclusterpropertyadminrole)* | [\`aws_cdk.aws_iam.Role\`](#aws_cdk.aws_iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`aws_auth\`](#awscdkawseksclusterpropertyawsauth)* | [\`aws_cdk.aws_eks.AwsAuth\`](#aws_cdk.aws_eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`cluster_arn\`](#awscdkawseksclusterpropertyclusterarn)* | \`str\` | The AWS generated ARN for the Cluster resource. | -| [\`cluster_certificate_authority_data\`](#awscdkawseksclusterpropertyclustercertificateauthoritydata)* | \`str\` | The certificate-authority-data for your cluster. | -| [\`cluster_encryption_config_key_arn\`](#awscdkawseksclusterpropertyclusterencryptionconfigkeyarn)* | \`str\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`cluster_endpoint\`](#awscdkawseksclusterpropertyclusterendpoint)* | \`str\` | The endpoint URL for the Cluster. | -| [\`cluster_name\`](#awscdkawseksclusterpropertyclustername)* | \`str\` | The Name of the created EKS Cluster. | -| [\`cluster_open_id_connect_issuer\`](#awscdkawseksclusterpropertyclusteropenidconnectissuer)* | \`str\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`cluster_open_id_connect_issuer_url\`](#awscdkawseksclusterpropertyclusteropenidconnectissuerurl)* | \`str\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`cluster_security_group\`](#awscdkawseksclusterpropertyclustersecuritygroup)* | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`cluster_security_group_id\`](#awscdkawseksclusterpropertyclustersecuritygroupid)* | \`str\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`connections\`](#awscdkawseksclusterpropertyconnections)* | [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`open_id_connect_provider\`](#awscdkawseksclusterpropertyopenidconnectprovider)* | [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`prune\`](#awscdkawseksclusterpropertyprune)* | \`bool\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`role\`](#awscdkawseksclusterpropertyrole)* | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`vpc\`](#awscdkawseksclusterpropertyvpc)* | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`default_capacity\`](#awscdkawseksclusterpropertydefaultcapacity) | [\`aws_cdk.aws_autoscaling.AutoScalingGroup\`](#aws_cdk.aws_autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`default_nodegroup\`](#awscdkawseksclusterpropertydefaultnodegroup) | [\`aws_cdk.aws_eks.Nodegroup\`](#aws_cdk.aws_eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`kubectl_environment\`](#awscdkawseksclusterpropertykubectlenvironment) | typing.Mapping[\`str\`] | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectl_layer\`](#awscdkawseksclusterpropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksclusterpropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`kubectl_private_subnets\`](#awscdkawseksclusterpropertykubectlprivatesubnets) | typing.List[[\`aws_cdk.aws_ec2.ISubnet\`](#aws_cdk.aws_ec2.ISubnet)] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectl_role\`](#awscdkawseksclusterpropertykubectlrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectl_security_group\`](#awscdkawseksclusterpropertykubectlsecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| admin_role | aws_cdk.aws_iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| aws_auth | AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| cluster_arn | str | The AWS generated ARN for the Cluster resource. | +| cluster_certificate_authority_data | str | The certificate-authority-data for your cluster. | +| cluster_encryption_config_key_arn | str | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| cluster_endpoint | str | The endpoint URL for the Cluster. | +| cluster_name | str | The Name of the created EKS Cluster. | +| cluster_open_id_connect_issuer | str | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| cluster_open_id_connect_issuer_url | str | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| cluster_security_group | aws_cdk.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| cluster_security_group_id | str | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| connections | aws_cdk.aws_ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| open_id_connect_provider | aws_cdk.aws_iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| prune | bool | Determines if Kubernetes resources can be pruned automatically. | +| role | aws_cdk.aws_iam.IRole | IAM role assumed by the EKS Control Plane. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| default_capacity | aws_cdk.aws_autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| default_nodegroup | Nodegroup | The node group that hosts the default capacity for this cluster. | +| kubectl_environment | typing.Mapping[str] | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| kubectl_private_subnets | typing.List[aws_cdk.aws_ec2.ISubnet] | Subnets to host the \`kubectl\` compute resources. | +| kubectl_role | aws_cdk.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectl_security_group | aws_cdk.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`admin_role\`Required +##### \`admin_role\`Required \`\`\`python admin_role: Role \`\`\` -- *Type:* [\`aws_cdk.aws_iam.Role\`](#aws_cdk.aws_iam.Role) +- *Type:* aws_cdk.aws_iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -68208,61 +70284,61 @@ This role also has \`systems:master\` permissions. --- -##### \`aws_auth\`Required +##### \`aws_auth\`Required \`\`\`python aws_auth: AwsAuth \`\`\` -- *Type:* [\`aws_cdk.aws_eks.AwsAuth\`](#aws_cdk.aws_eks.AwsAuth) +- *Type:* AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`cluster_arn\`Required +##### \`cluster_arn\`Required \`\`\`python cluster_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The AWS generated ARN for the Cluster resource. --- -##### \`cluster_certificate_authority_data\`Required +##### \`cluster_certificate_authority_data\`Required \`\`\`python cluster_certificate_authority_data: str \`\`\` -- *Type:* \`str\` +- *Type:* str The certificate-authority-data for your cluster. --- -##### \`cluster_encryption_config_key_arn\`Required +##### \`cluster_encryption_config_key_arn\`Required \`\`\`python cluster_encryption_config_key_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`cluster_endpoint\`Required +##### \`cluster_endpoint\`Required \`\`\`python cluster_endpoint: str \`\`\` -- *Type:* \`str\` +- *Type:* str The endpoint URL for the Cluster. @@ -68270,25 +70346,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The Name of the created EKS Cluster. --- -##### \`cluster_open_id_connect_issuer\`Required +##### \`cluster_open_id_connect_issuer\`Required \`\`\`python cluster_open_id_connect_issuer: str \`\`\` -- *Type:* \`str\` +- *Type:* str If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -68296,13 +70372,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`cluster_open_id_connect_issuer_url\`Required +##### \`cluster_open_id_connect_issuer_url\`Required \`\`\`python cluster_open_id_connect_issuer_url: str \`\`\` -- *Type:* \`str\` +- *Type:* str If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -68310,49 +70386,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`cluster_security_group\`Required +##### \`cluster_security_group\`Required \`\`\`python cluster_security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`cluster_security_group_id\`Required +##### \`cluster_security_group_id\`Required \`\`\`python cluster_security_group_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`python connections: Connections \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) +- *Type:* aws_cdk.aws_ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`open_id_connect_provider\`Required +##### \`open_id_connect_provider\`Required \`\`\`python open_id_connect_provider: IOpenIdConnectProvider \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) +- *Type:* aws_cdk.aws_iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -68360,49 +70436,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool Determines if Kubernetes resources can be pruned automatically. --- -##### \`role\`Required +##### \`role\`Required \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`default_capacity\`Optional +##### \`default_capacity\`Optional \`\`\`python default_capacity: AutoScalingGroup \`\`\` -- *Type:* [\`aws_cdk.aws_autoscaling.AutoScalingGroup\`](#aws_cdk.aws_autoscaling.AutoScalingGroup) +- *Type:* aws_cdk.aws_autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -68410,13 +70486,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`default_nodegroup\`Optional +##### \`default_nodegroup\`Optional \`\`\`python default_nodegroup: Nodegroup \`\`\` -- *Type:* [\`aws_cdk.aws_eks.Nodegroup\`](#aws_cdk.aws_eks.Nodegroup) +- *Type:* Nodegroup The node group that hosts the default capacity for this cluster. @@ -68424,25 +70500,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -68450,38 +70526,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`kubectl_private_subnets\`Optional +##### \`kubectl_private_subnets\`Optional \`\`\`python kubectl_private_subnets: typing.List[ISubnet] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.ISubnet\`](#aws_cdk.aws_ec2.ISubnet)] +- *Type:* typing.List[aws_cdk.aws_ec2.ISubnet] - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`kubectl_role\`Optional +##### \`kubectl_role\`Optional \`\`\`python kubectl_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -68489,13 +70565,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectl_security_group\`Optional +##### \`kubectl_security_group\`Optional \`\`\`python kubectl_security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -68503,13 +70579,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -68542,72 +70618,72 @@ aws_eks.FargateCluster( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksfargateclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawseksfargateclusterparameterid)* | \`str\` | *No description.* | -| [\`version\`](#awscdkawseksfargateclusterpropsparameterversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawseksfargateclusterpropsparameterclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawseksfargateclusterpropsparameteroutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawseksfargateclusterpropsparameteroutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawseksfargateclusterpropsparameterrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawseksfargateclusterpropsparametersecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawseksfargateclusterpropsparametervpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawseksfargateclusterpropsparametervpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | -| [\`cluster_handler_environment\`](#awscdkawseksfargateclusterpropsparameterclusterhandlerenvironment) | typing.Mapping[\`str\`] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`core_dns_compute_type\`](#awscdkawseksfargateclusterpropsparametercorednscomputetype) | [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpoint_access\`](#awscdkawseksfargateclusterpropsparameterendpointaccess) | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectl_environment\`](#awscdkawseksfargateclusterpropsparameterkubectlenvironment) | typing.Mapping[\`str\`] | Environment variables for the kubectl execution. | -| [\`kubectl_layer\`](#awscdkawseksfargateclusterpropsparameterkubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksfargateclusterpropsparameterkubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`masters_role\`](#awscdkawseksfargateclusterpropsparametermastersrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`output_masters_role_arn\`](#awscdkawseksfargateclusterpropsparameteroutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`place_cluster_handler_in_vpc\`](#awscdkawseksfargateclusterpropsparameterplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdkawseksfargateclusterpropsparameterprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secrets_encryption_key\`](#awscdkawseksfargateclusterpropsparametersecretsencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`default_profile\`](#awscdkawseksfargateclusterpropsparameterdefaultprofile) | [\`aws_cdk.aws_eks.FargateProfileOptions\`](#aws_cdk.aws_eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | +| cluster_handler_environment | typing.Mapping[str] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| core_dns_compute_type | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpoint_access | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectl_environment | typing.Mapping[str] | Environment variables for the kubectl execution. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| masters_role | aws_cdk.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| output_masters_role_arn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| place_cluster_handler_in_vpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secrets_encryption_key | aws_cdk.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| default_profile | FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`version\`Required +##### \`version\`Required -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -68616,36 +70692,36 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -68654,38 +70730,38 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`cluster_handler_environment\`Optional +##### \`cluster_handler_environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`core_dns_compute_type\`Optional +##### \`core_dns_compute_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpoint_access\`Optional +##### \`endpoint_access\`Optional -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -68694,60 +70770,60 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`python # Example automatically generated from non-compiling source. May contain errors. layer = lambda_.LayerVersion(self, \\"kubectl-layer\\", code=lambda_.Code.from_asset(f\\"{__dirname}/layer.zip\\") )# compatible_runtimes: [lambda.Runtime.PROVIDED] \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`masters_role\`Optional +##### \`masters_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`output_masters_role_arn\`Optional +##### \`output_masters_role_arn\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`place_cluster_handler_in_vpc\`Optional +##### \`place_cluster_handler_in_vpc\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -68756,18 +70832,18 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secrets_encryption_key\`Optional +##### \`secrets_encryption_key\`Optional -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`default_profile\`Optional +##### \`default_profile\`Optional -- *Type:* [\`aws_cdk.aws_eks.FargateProfileOptions\`](#aws_cdk.aws_eks.FargateProfileOptions) +- *Type:* FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. @@ -68778,15 +70854,15 @@ Fargate Profile to create along with the cluster. -### FargateProfile +### FargateProfile -- *Implements:* [\`aws_cdk.ITaggable\`](#aws_cdk.ITaggable) +- *Implements:* aws_cdk.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -68805,32 +70881,32 @@ aws_eks.FargateProfile( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksfargateprofileparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawseksfargateprofileparameterid)* | \`str\` | *No description.* | -| [\`selectors\`](#awscdkawseksfargateprofilepropsparameterselectors)* | typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] | The selectors to match for pods to use this Fargate profile. | -| [\`fargate_profile_name\`](#awscdkawseksfargateprofilepropsparameterfargateprofilename) | \`str\` | The name of the Fargate profile. | -| [\`pod_execution_role\`](#awscdkawseksfargateprofilepropsparameterpodexecutionrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnet_selection\`](#awscdkawseksfargateprofilepropsparametersubnetselection) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#awscdkawseksfargateprofilepropsparametervpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#awscdkawseksfargateprofilepropsparametercluster)* | [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| selectors | typing.List[Selector] | The selectors to match for pods to use this Fargate profile. | +| fargate_profile_name | str | The name of the Fargate profile. | +| pod_execution_role | aws_cdk.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnet_selection | aws_cdk.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`selectors\`Required +##### \`selectors\`Required -- *Type:* typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] +- *Type:* typing.List[Selector] The selectors to match for pods to use this Fargate profile. @@ -68838,31 +70914,31 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* generated The name of the Fargate profile. --- -##### \`pod_execution_role\`Optional +##### \`pod_execution_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnet_selection\`Optional +##### \`subnet_selection\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -68871,9 +70947,9 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -68882,9 +70958,9 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply the Fargate profile to. @@ -68894,48 +70970,48 @@ The EKS cluster to apply the Fargate profile to. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`fargate_profile_arn\`](#awscdkawseksfargateprofilepropertyfargateprofilearn)* | \`str\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`fargate_profile_name\`](#awscdkawseksfargateprofilepropertyfargateprofilename)* | \`str\` | The name of the Fargate profile. | -| [\`pod_execution_role\`](#awscdkawseksfargateprofilepropertypodexecutionrole)* | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`tags\`](#awscdkawseksfargateprofilepropertytags)* | [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) | Resource tags. | +| fargate_profile_arn | str | The full Amazon Resource Name (ARN) of the Fargate profile. | +| fargate_profile_name | str | The name of the Fargate profile. | +| pod_execution_role | aws_cdk.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| tags | aws_cdk.TagManager | Resource tags. | --- -##### \`fargate_profile_arn\`Required +##### \`fargate_profile_arn\`Required \`\`\`python fargate_profile_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`fargate_profile_name\`Required +##### \`fargate_profile_name\`Required \`\`\`python fargate_profile_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the Fargate profile. --- -##### \`pod_execution_role\`Required +##### \`pod_execution_role\`Required \`\`\`python pod_execution_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -68943,26 +71019,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`python tags: TagManager \`\`\` -- *Type:* [\`aws_cdk.TagManager\`](#aws_cdk.TagManager) +- *Type:* aws_cdk.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -68985,71 +71061,71 @@ aws_eks.HelmChart( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekshelmchartparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsekshelmchartparameterid)* | \`str\` | *No description.* | -| [\`chart\`](#awscdkawsekshelmchartpropsparameterchart)* | \`str\` | The name of the chart. | -| [\`create_namespace\`](#awscdkawsekshelmchartpropsparametercreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`namespace\`](#awscdkawsekshelmchartpropsparameternamespace) | \`str\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#awscdkawsekshelmchartpropsparameterrelease) | \`str\` | The name of the release. | -| [\`repository\`](#awscdkawsekshelmchartpropsparameterrepository) | \`str\` | The repository which contains the chart. | -| [\`timeout\`](#awscdkawsekshelmchartpropsparametertimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#awscdkawsekshelmchartpropsparametervalues) | typing.Mapping[\`typing.Any\`] | The values to be used by the chart. | -| [\`version\`](#awscdkawsekshelmchartpropsparameterversion) | \`str\` | The chart version to install. | -| [\`wait\`](#awscdkawsekshelmchartpropsparameterwait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#awscdkawsekshelmchartpropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to apply this configuration to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| chart | str | The name of the chart. | +| create_namespace | bool | create namespace if not exist. | +| namespace | str | The Kubernetes namespace scope of the requests. | +| release | str | The name of the release. | +| repository | str | The repository which contains the chart. | +| timeout | aws_cdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | typing.Mapping[typing.Any] | The values to be used by the chart. | +| version | str | The chart version to install. | +| wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | ICluster | The EKS cluster to apply this configuration to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`chart\`Required +##### \`chart\`Required -- *Type:* \`str\` +- *Type:* str The name of the chart. --- -##### \`create_namespace\`Optional +##### \`create_namespace\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -69058,9 +71134,9 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -69069,36 +71145,36 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this configuration to. @@ -69109,29 +71185,33 @@ The EKS cluster to apply this configuration to. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdkawsekshelmchartpropertyresourcetype)* | \`str\` | The CloudFormation resource type. | +| RESOURCE_TYPE | str | The CloudFormation resource type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`python +RESOURCE_TYPE: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69149,53 +71229,53 @@ aws_eks.KubernetesManifest( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekskubernetesmanifestparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsekskubernetesmanifestparameterid)* | \`str\` | *No description.* | -| [\`prune\`](#awscdkawsekskubernetesmanifestpropsparameterprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skip_validation\`](#awscdkawsekskubernetesmanifestpropsparameterskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#awscdkawsekskubernetesmanifestpropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#awscdkawsekskubernetesmanifestpropsparametermanifest)* | typing.List[typing.Mapping[\`typing.Any\`]] | The manifest to apply. | -| [\`overwrite\`](#awscdkawsekskubernetesmanifestpropsparameteroverwrite) | \`bool\` | Overwrite any existing resources. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skip_validation | bool | A flag to signify if the manifest validation should be skipped. | +| cluster | ICluster | The EKS cluster to apply this manifest to. | +| manifest | typing.List[typing.Mapping[typing.Any]] | The manifest to apply. | +| overwrite | bool | Overwrite any existing resources. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`prune\`Optional +##### \`prune\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skip_validation\`Optional +##### \`skip_validation\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this manifest to. @@ -69203,9 +71283,9 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required -- *Type:* typing.List[typing.Mapping[\`typing.Any\`]] +- *Type:* typing.List[typing.Mapping[typing.Any]] The manifest to apply. @@ -69213,9 +71293,9 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Overwrite any existing resources. @@ -69227,29 +71307,33 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdkawsekskubernetesmanifestpropertyresourcetype)* | \`str\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | str | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`python +RESOURCE_TYPE: str +\`\`\` -- *Type:* \`str\` +- *Type:* str The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69268,32 +71352,32 @@ aws_eks.KubernetesObjectValue( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekskubernetesobjectvalueparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsekskubernetesobjectvalueparameterid)* | \`str\` | *No description.* | -| [\`cluster\`](#awscdkawsekskubernetesobjectvaluepropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`json_path\`](#awscdkawsekskubernetesobjectvaluepropsparameterjsonpath)* | \`str\` | JSONPath to the specific value. | -| [\`object_name\`](#awscdkawsekskubernetesobjectvaluepropsparameterobjectname)* | \`str\` | The name of the object to query. | -| [\`object_type\`](#awscdkawsekskubernetesobjectvaluepropsparameterobjecttype)* | \`str\` | The object type to query. | -| [\`object_namespace\`](#awscdkawsekskubernetesobjectvaluepropsparameterobjectnamespace) | \`str\` | The namespace the object belongs to. | -| [\`timeout\`](#awscdkawsekskubernetesobjectvaluepropsparametertimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Timeout for waiting on a value. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| cluster | ICluster | The EKS cluster to fetch attributes from. | +| json_path | str | JSONPath to the specific value. | +| object_name | str | The name of the object to query. | +| object_type | str | The object type to query. | +| object_namespace | str | The namespace the object belongs to. | +| timeout | aws_cdk.Duration | Timeout for waiting on a value. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to fetch attributes from. @@ -69301,27 +71385,27 @@ The EKS cluster to fetch attributes from. --- -##### \`json_path\`Required +##### \`json_path\`Required -- *Type:* \`str\` +- *Type:* str JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`object_name\`Required +##### \`object_name\`Required -- *Type:* \`str\` +- *Type:* str The name of the object to query. --- -##### \`object_type\`Required +##### \`object_type\`Required -- *Type:* \`str\` +- *Type:* str The object type to query. @@ -69329,18 +71413,18 @@ The object type to query. --- -##### \`object_namespace\`Optional +##### \`object_namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. @@ -69349,49 +71433,53 @@ Timeout for waiting on a value. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`value\`](#awscdkawsekskubernetesobjectvaluepropertyvalue)* | \`str\` | The value as a string token. | +| value | str | The value as a string token. | --- -##### \`value\`Required +##### \`value\`Required \`\`\`python value: str \`\`\` -- *Type:* \`str\` +- *Type:* str The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdkawsekskubernetesobjectvaluepropertyresourcetype)* | \`str\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | str | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required -- *Type:* \`str\` +\`\`\`python +RESOURCE_TYPE: str +\`\`\` + +- *Type:* str The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69410,40 +71498,40 @@ aws_eks.KubernetesPatch( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsekskubernetespatchparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsekskubernetespatchparameterid)* | \`str\` | *No description.* | -| [\`apply_patch\`](#awscdkawsekskubernetespatchpropsparameterapplypatch)* | typing.Mapping[\`typing.Any\`] | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#awscdkawsekskubernetespatchpropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The cluster to apply the patch to. | -| [\`resource_name\`](#awscdkawsekskubernetespatchpropsparameterresourcename)* | \`str\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restore_patch\`](#awscdkawsekskubernetespatchpropsparameterrestorepatch)* | typing.Mapping[\`typing.Any\`] | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patch_type\`](#awscdkawsekskubernetespatchpropsparameterpatchtype) | [\`aws_cdk.aws_eks.PatchType\`](#aws_cdk.aws_eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resource_namespace\`](#awscdkawsekskubernetespatchpropsparameterresourcenamespace) | \`str\` | The kubernetes API namespace. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| apply_patch | typing.Mapping[typing.Any] | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | ICluster | The cluster to apply the patch to. | +| resource_name | str | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restore_patch | typing.Mapping[typing.Any] | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patch_type | PatchType | The patch type to pass to \`kubectl patch\`. | +| resource_namespace | str | The kubernetes API namespace. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`apply_patch\`Required +##### \`apply_patch\`Required -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. @@ -69451,25 +71539,25 @@ The cluster to apply the patch to. --- -##### \`resource_name\`Required +##### \`resource_name\`Required -- *Type:* \`str\` +- *Type:* str The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restore_patch\`Required +##### \`restore_patch\`Required -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patch_type\`Optional +##### \`patch_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.PatchType\`](#aws_cdk.aws_eks.PatchType) +- *Type:* PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -69478,9 +71566,9 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resource_namespace\`Optional +##### \`resource_namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The kubernetes API namespace. @@ -69491,13 +71579,13 @@ The kubernetes API namespace. -### Nodegroup +### Nodegroup -- *Implements:* [\`aws_cdk.aws_eks.INodegroup\`](#aws_cdk.aws_eks.INodegroup) +- *Implements:* INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69527,61 +71615,61 @@ aws_eks.Nodegroup( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksnodegroupparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawseksnodegroupparameterid)* | \`str\` | *No description.* | -| [\`ami_type\`](#awscdkawseksnodegrouppropsparameteramitype) | [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacity_type\`](#awscdkawseksnodegrouppropsparametercapacitytype) | [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desired_size\`](#awscdkawseksnodegrouppropsparameterdesiredsize) | \`typing.Union[int, float]\` | The current number of worker nodes that the managed node group should maintain. | -| [\`disk_size\`](#awscdkawseksnodegrouppropsparameterdisksize) | \`typing.Union[int, float]\` | The root device disk size (in GiB) for your node group instances. | -| [\`force_update\`](#awscdkawseksnodegrouppropsparameterforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instance_types\`](#awscdkawseksnodegrouppropsparameterinstancetypes) | typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] | The instance types to use for your node group. | -| [\`labels\`](#awscdkawseksnodegrouppropsparameterlabels) | typing.Mapping[\`str\`] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launch_template_spec\`](#awscdkawseksnodegrouppropsparameterlaunchtemplatespec) | [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`max_size\`](#awscdkawseksnodegrouppropsparametermaxsize) | \`typing.Union[int, float]\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`min_size\`](#awscdkawseksnodegrouppropsparameterminsize) | \`typing.Union[int, float]\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroup_name\`](#awscdkawseksnodegrouppropsparameternodegroupname) | \`str\` | Name of the Nodegroup. | -| [\`node_role\`](#awscdkawseksnodegrouppropsparameternoderole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`release_version\`](#awscdkawseksnodegrouppropsparameterreleaseversion) | \`str\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remote_access\`](#awscdkawseksnodegrouppropsparameterremoteaccess) | [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#awscdkawseksnodegrouppropsparametersubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#awscdkawseksnodegrouppropsparametertags) | typing.Mapping[\`str\`] | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#awscdkawseksnodegrouppropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | Cluster resource. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| ami_type | NodegroupAmiType | The AMI type for your node group. | +| capacity_type | CapacityType | The capacity type of the nodegroup. | +| desired_size | typing.Union[int, float] | The current number of worker nodes that the managed node group should maintain. | +| disk_size | typing.Union[int, float] | The root device disk size (in GiB) for your node group instances. | +| force_update | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instance_types | typing.List[aws_cdk.aws_ec2.InstanceType] | The instance types to use for your node group. | +| labels | typing.Mapping[str] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launch_template_spec | LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| max_size | typing.Union[int, float] | The maximum number of worker nodes that the managed node group can scale out to. | +| min_size | typing.Union[int, float] | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroup_name | str | Name of the Nodegroup. | +| node_role | aws_cdk.aws_iam.IRole | The IAM role to associate with your node group. | +| release_version | str | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remote_access | NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | aws_cdk.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | typing.Mapping[str] | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | ICluster | Cluster resource. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desired_size\`Optional +##### \`desired_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -69590,18 +71678,18 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`force_update\`Optional +##### \`force_update\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -69610,40 +71698,40 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional -- *Type:* typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] +- *Type:* typing.List[aws_cdk.aws_ec2.InstanceType] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launch_template_spec\`Optional +##### \`launch_template_spec\`Optional -- *Type:* [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`max_size\`Optional +##### \`max_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -69652,9 +71740,9 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`min_size\`Optional +##### \`min_size\`Optional -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -69663,18 +71751,18 @@ This number must be greater than zero. --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* resource ID Name of the Nodegroup. --- -##### \`node_role\`Optional +##### \`node_role\`Optional -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -69683,18 +71771,18 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`release_version\`Optional +##### \`release_version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional -- *Type:* [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -69703,9 +71791,9 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -69714,9 +71802,9 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -69725,24 +71813,24 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster Cluster resource. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`from_nodegroup_name\`](#awscdkawseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| from_nodegroup_name | Import the Nodegroup from attributes. | --- -##### \`from_nodegroup_name\` +##### \`from_nodegroup_name\` \`\`\`python from aws_cdk import aws_eks @@ -69754,93 +71842,93 @@ aws_eks.Nodegroup.from_nodegroup_name( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -###### \`nodegroup_name\`Required +###### \`nodegroup_name\`Required -- *Type:* \`str\` +- *Type:* str --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdkawseksnodegrouppropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | the Amazon EKS cluster resource. | -| [\`nodegroup_arn\`](#awscdkawseksnodegrouppropertynodegrouparn)* | \`str\` | ARN of the nodegroup. | -| [\`nodegroup_name\`](#awscdkawseksnodegrouppropertynodegroupname)* | \`str\` | Nodegroup name. | -| [\`role\`](#awscdkawseksnodegrouppropertyrole)* | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | IAM role of the instance profile for the nodegroup. | +| cluster | ICluster | the Amazon EKS cluster resource. | +| nodegroup_arn | str | ARN of the nodegroup. | +| nodegroup_name | str | Nodegroup name. | +| role | aws_cdk.aws_iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster the Amazon EKS cluster resource. --- -##### \`nodegroup_arn\`Required +##### \`nodegroup_arn\`Required \`\`\`python nodegroup_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str ARN of the nodegroup. --- -##### \`nodegroup_name\`Required +##### \`nodegroup_name\`Required \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str Nodegroup name. --- -##### \`role\`Required +##### \`role\`Required \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69854,31 +71942,31 @@ aws_eks.OpenIdConnectProvider( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksopenidconnectproviderparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | The definition scope. | -| [\`id\`](#awscdkawseksopenidconnectproviderparameterid)* | \`str\` | Construct ID. | -| [\`url\`](#awscdkawseksopenidconnectproviderpropsparameterurl)* | \`str\` | The URL of the identity provider. | +| scope | constructs.Construct | The definition scope. | +| id | str | Construct ID. | +| url | str | The URL of the identity provider. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct The definition scope. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str Construct ID. --- -##### \`url\`Required +##### \`url\`Required -- *Type:* \`str\` +- *Type:* str The URL of the identity provider. @@ -69890,13 +71978,13 @@ The URL must begin with https:// and should correspond to the iss claim in the p -### ServiceAccount +### ServiceAccount -- *Implements:* [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) +- *Implements:* aws_cdk.aws_iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -69912,61 +72000,61 @@ aws_eks.ServiceAccount( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawseksserviceaccountparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawseksserviceaccountparameterid)* | \`str\` | *No description.* | -| [\`name\`](#awscdkawseksserviceaccountpropsparametername) | \`str\` | The name of the service account. | -| [\`namespace\`](#awscdkawseksserviceaccountpropsparameternamespace) | \`str\` | The namespace of the service account. | -| [\`cluster\`](#awscdkawseksserviceaccountpropsparametercluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The cluster to apply the patch to. | +| scope | constructs.Construct | *No description.* | +| id | str | *No description.* | +| name | str | The name of the service account. | +| namespace | str | The namespace of the service account. | +| cluster | ICluster | The cluster to apply the patch to. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -##### \`name\`Optional +##### \`name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_principal_policy\`](#awscdkawseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| add_to_principal_policy | Add to the policy of this principal. | --- -##### \`add_to_principal_policy\` +##### \`add_to_principal_policy\` \`\`\`python def add_to_principal_policy( @@ -69974,106 +72062,106 @@ def add_to_principal_policy( ) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`assume_role_action\`](#awscdkawseksserviceaccountpropertyassumeroleaction)* | \`str\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`grant_principal\`](#awscdkawseksserviceaccountpropertygrantprincipal)* | [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) | The principal to grant permissions to. | -| [\`policy_fragment\`](#awscdkawseksserviceaccountpropertypolicyfragment)* | [\`aws_cdk.aws_iam.PrincipalPolicyFragment\`](#aws_cdk.aws_iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`role\`](#awscdkawseksserviceaccountpropertyrole)* | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The role which is linked to the service account. | -| [\`service_account_name\`](#awscdkawseksserviceaccountpropertyserviceaccountname)* | \`str\` | The name of the service account. | -| [\`service_account_namespace\`](#awscdkawseksserviceaccountpropertyserviceaccountnamespace)* | \`str\` | The namespace where the service account is located in. | +| assume_role_action | str | When this Principal is used in an AssumeRole policy, the action to use. | +| grant_principal | aws_cdk.aws_iam.IPrincipal | The principal to grant permissions to. | +| policy_fragment | aws_cdk.aws_iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| role | aws_cdk.aws_iam.IRole | The role which is linked to the service account. | +| service_account_name | str | The name of the service account. | +| service_account_namespace | str | The namespace where the service account is located in. | --- -##### \`assume_role_action\`Required +##### \`assume_role_action\`Required \`\`\`python assume_role_action: str \`\`\` -- *Type:* \`str\` +- *Type:* str When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`grant_principal\`Required +##### \`grant_principal\`Required \`\`\`python grant_principal: IPrincipal \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IPrincipal\`](#aws_cdk.aws_iam.IPrincipal) +- *Type:* aws_cdk.aws_iam.IPrincipal The principal to grant permissions to. --- -##### \`policy_fragment\`Required +##### \`policy_fragment\`Required \`\`\`python policy_fragment: PrincipalPolicyFragment \`\`\` -- *Type:* [\`aws_cdk.aws_iam.PrincipalPolicyFragment\`](#aws_cdk.aws_iam.PrincipalPolicyFragment) +- *Type:* aws_cdk.aws_iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`role\`Required +##### \`role\`Required \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole The role which is linked to the service account. --- -##### \`service_account_name\`Required +##### \`service_account_name\`Required \`\`\`python service_account_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the service account. --- -##### \`service_account_namespace\`Required +##### \`service_account_namespace\`Required \`\`\`python service_account_namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70108,72 +72196,72 @@ aws_eks.AutoScalingGroupCapacityOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`allow_all_outbound\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`bool\` | Whether the instances can initiate connections to anywhere by default. | -| [\`associate_public_ip_address\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`bool\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`auto_scaling_group_name\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`str\` | The name of the Auto Scaling group. | -| [\`block_devices\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyblockdevices) | typing.List[[\`aws_cdk.aws_autoscaling.BlockDevice\`](#aws_cdk.aws_autoscaling.BlockDevice)] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`cooldown\`](#awscdkawseksautoscalinggroupcapacityoptionspropertycooldown) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`desired_capacity\`](#awscdkawseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`typing.Union[int, float]\` | Initial amount of instances in the fleet. | -| [\`group_metrics\`](#awscdkawseksautoscalinggroupcapacityoptionspropertygroupmetrics) | typing.List[[\`aws_cdk.aws_autoscaling.GroupMetrics\`](#aws_cdk.aws_autoscaling.GroupMetrics)] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`health_check\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`aws_cdk.aws_autoscaling.HealthCheck\`](#aws_cdk.aws_autoscaling.HealthCheck) | Configuration for health checks. | -| [\`ignore_unmodified_size_properties\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`bool\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`instance_monitoring\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`aws_cdk.aws_autoscaling.Monitoring\`](#aws_cdk.aws_autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`key_name\`](#awscdkawseksautoscalinggroupcapacityoptionspropertykeyname) | \`str\` | Name of SSH keypair to grant access to instances. | -| [\`max_capacity\`](#awscdkawseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`typing.Union[int, float]\` | Maximum number of instances in the fleet. | -| [\`max_instance_lifetime\`](#awscdkawseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | The maximum amount of time that an instance can be in service. | -| [\`min_capacity\`](#awscdkawseksautoscalinggroupcapacityoptionspropertymincapacity) | \`typing.Union[int, float]\` | Minimum number of instances in the fleet. | -| [\`new_instances_protected_from_scale_in\`](#awscdkawseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`bool\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`notifications\`](#awscdkawseksautoscalinggroupcapacityoptionspropertynotifications) | typing.List[[\`aws_cdk.aws_autoscaling.NotificationConfiguration\`](#aws_cdk.aws_autoscaling.NotificationConfiguration)] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`signals\`](#awscdkawseksautoscalinggroupcapacityoptionspropertysignals) | [\`aws_cdk.aws_autoscaling.Signals\`](#aws_cdk.aws_autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`spot_price\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyspotprice) | \`str\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`update_policy\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`aws_cdk.aws_autoscaling.UpdatePolicy\`](#aws_cdk.aws_autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`vpc_subnets\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`instance_type\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) | Instance type of the instances to start. | -| [\`bootstrap_enabled\`](#awscdkawseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrap_options\`](#awscdkawseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`machine_image_type\`](#awscdkawseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) | Machine image type. | -| [\`map_role\`](#awscdkawseksautoscalinggroupcapacityoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spot_interrupt_handler\`](#awscdkawseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| allow_all_outbound | bool | Whether the instances can initiate connections to anywhere by default. | +| associate_public_ip_address | bool | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| auto_scaling_group_name | str | The name of the Auto Scaling group. | +| block_devices | typing.List[aws_cdk.aws_autoscaling.BlockDevice] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| cooldown | aws_cdk.Duration | Default scaling cooldown for this AutoScalingGroup. | +| desired_capacity | typing.Union[int, float] | Initial amount of instances in the fleet. | +| group_metrics | typing.List[aws_cdk.aws_autoscaling.GroupMetrics] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| health_check | aws_cdk.aws_autoscaling.HealthCheck | Configuration for health checks. | +| ignore_unmodified_size_properties | bool | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| instance_monitoring | aws_cdk.aws_autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| key_name | str | Name of SSH keypair to grant access to instances. | +| max_capacity | typing.Union[int, float] | Maximum number of instances in the fleet. | +| max_instance_lifetime | aws_cdk.Duration | The maximum amount of time that an instance can be in service. | +| min_capacity | typing.Union[int, float] | Minimum number of instances in the fleet. | +| new_instances_protected_from_scale_in | bool | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| notifications | typing.List[aws_cdk.aws_autoscaling.NotificationConfiguration] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| signals | aws_cdk.aws_autoscaling.Signals | Configure waiting for signals during deployment. | +| spot_price | str | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| update_policy | aws_cdk.aws_autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| vpc_subnets | aws_cdk.aws_ec2.SubnetSelection | Where to place instances within the VPC. | +| instance_type | aws_cdk.aws_ec2.InstanceType | Instance type of the instances to start. | +| bootstrap_enabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrap_options | BootstrapOptions | EKS node bootstrapping options. | +| machine_image_type | MachineImageType | Machine image type. | +| map_role | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spot_interrupt_handler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`allow_all_outbound\`Optional +##### \`allow_all_outbound\`Optional \`\`\`python allow_all_outbound: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`associate_public_ip_address\`Optional +##### \`associate_public_ip_address\`Optional \`\`\`python associate_public_ip_address: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`auto_scaling_group_name\`Optional +##### \`auto_scaling_group_name\`Optional \`\`\`python auto_scaling_group_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -70182,60 +72270,60 @@ This name must be unique per Region per account. --- -##### \`block_devices\`Optional +##### \`block_devices\`Optional \`\`\`python block_devices: typing.List[BlockDevice] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.BlockDevice\`](#aws_cdk.aws_autoscaling.BlockDevice)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.BlockDevice] - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`cooldown\`Optional +##### \`cooldown\`Optional \`\`\`python cooldown: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`desired_capacity\`Optional +##### \`desired_capacity\`Optional \`\`\`python desired_capacity: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`group_metrics\`Optional +##### \`group_metrics\`Optional \`\`\`python group_metrics: typing.List[GroupMetrics] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.GroupMetrics\`](#aws_cdk.aws_autoscaling.GroupMetrics)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.GroupMetrics] - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -70244,26 +72332,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`health_check\`Optional +##### \`health_check\`Optional \`\`\`python health_check: HealthCheck \`\`\` -- *Type:* [\`aws_cdk.aws_autoscaling.HealthCheck\`](#aws_cdk.aws_autoscaling.HealthCheck) +- *Type:* aws_cdk.aws_autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`ignore_unmodified_size_properties\`Optional +##### \`ignore_unmodified_size_properties\`Optional \`\`\`python ignore_unmodified_size_properties: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -70272,86 +72360,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`instance_monitoring\`Optional +##### \`instance_monitoring\`Optional \`\`\`python instance_monitoring: Monitoring \`\`\` -- *Type:* [\`aws_cdk.aws_autoscaling.Monitoring\`](#aws_cdk.aws_autoscaling.Monitoring) +- *Type:* aws_cdk.aws_autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`key_name\`Optional +##### \`key_name\`Optional \`\`\`python key_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`max_capacity\`Optional +##### \`max_capacity\`Optional \`\`\`python max_capacity: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`max_instance_lifetime\`Optional +##### \`max_instance_lifetime\`Optional \`\`\`python max_instance_lifetime: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`min_capacity\`Optional +##### \`min_capacity\`Optional \`\`\`python min_capacity: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`new_instances_protected_from_scale_in\`Optional +##### \`new_instances_protected_from_scale_in\`Optional \`\`\`python new_instances_protected_from_scale_in: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -70360,28 +72448,28 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`notifications\`Optional +##### \`notifications\`Optional \`\`\`python notifications: typing.List[NotificationConfiguration] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_autoscaling.NotificationConfiguration\`](#aws_cdk.aws_autoscaling.NotificationConfiguration)] +- *Type:* typing.List[aws_cdk.aws_autoscaling.NotificationConfiguration] - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### \`signals\`Optional +##### \`signals\`Optional \`\`\`python signals: Signals \`\`\` -- *Type:* [\`aws_cdk.aws_autoscaling.Signals\`](#aws_cdk.aws_autoscaling.Signals) +- *Type:* aws_cdk.aws_autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -70390,13 +72478,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`spot_price\`Optional +##### \`spot_price\`Optional \`\`\`python spot_price: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -70405,13 +72493,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`update_policy\`Optional +##### \`update_policy\`Optional \`\`\`python update_policy: UpdatePolicy \`\`\` -- *Type:* [\`aws_cdk.aws_autoscaling.UpdatePolicy\`](#aws_cdk.aws_autoscaling.UpdatePolicy) +- *Type:* aws_cdk.aws_autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -70420,38 +72508,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`instance_type\`Required +##### \`instance_type\`Required \`\`\`python instance_type: InstanceType \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) +- *Type:* aws_cdk.aws_ec2.InstanceType Instance type of the instances to start. --- -##### \`bootstrap_enabled\`Optional +##### \`bootstrap_enabled\`Optional \`\`\`python bootstrap_enabled: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -70460,39 +72548,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrap_options\`Optional +##### \`bootstrap_options\`Optional \`\`\`python bootstrap_options: BootstrapOptions \`\`\` -- *Type:* [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`machine_image_type\`Optional +##### \`machine_image_type\`Optional \`\`\`python machine_image_type: MachineImageType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`map_role\`Optional +##### \`map_role\`Optional \`\`\`python map_role: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -70501,13 +72589,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spot_interrupt_handler\`Optional +##### \`spot_interrupt_handler\`Optional \`\`\`python spot_interrupt_handler: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -70516,11 +72604,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70534,25 +72622,25 @@ aws_eks.AutoScalingGroupOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`bootstrap_enabled\`](#awscdkawseksautoscalinggroupoptionspropertybootstrapenabled) | \`bool\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrap_options\`](#awscdkawseksautoscalinggroupoptionspropertybootstrapoptions) | [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`machine_image_type\`](#awscdkawseksautoscalinggroupoptionspropertymachineimagetype) | [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`map_role\`](#awscdkawseksautoscalinggroupoptionspropertymaprole) | \`bool\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spot_interrupt_handler\`](#awscdkawseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`bool\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| bootstrap_enabled | bool | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrap_options | BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| machine_image_type | MachineImageType | Allow options to specify different machine image type. | +| map_role | bool | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spot_interrupt_handler | bool | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`bootstrap_enabled\`Optional +##### \`bootstrap_enabled\`Optional \`\`\`python bootstrap_enabled: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -70561,39 +72649,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrap_options\`Optional +##### \`bootstrap_options\`Optional \`\`\`python bootstrap_options: BootstrapOptions \`\`\` -- *Type:* [\`aws_cdk.aws_eks.BootstrapOptions\`](#aws_cdk.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`machine_image_type\`Optional +##### \`machine_image_type\`Optional \`\`\`python machine_image_type: MachineImageType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.MachineImageType\`](#aws_cdk.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`map_role\`Optional +##### \`map_role\`Optional \`\`\`python map_role: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -70602,13 +72690,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spot_interrupt_handler\`Optional +##### \`spot_interrupt_handler\`Optional \`\`\`python spot_interrupt_handler: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -70617,11 +72705,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70632,47 +72720,47 @@ aws_eks.AwsAuthMapping( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`groups\`](#awscdkawseksawsauthmappingpropertygroups)* | typing.List[\`str\`] | A list of groups within Kubernetes to which the role is mapped. | -| [\`username\`](#awscdkawseksawsauthmappingpropertyusername) | \`str\` | The user name within Kubernetes to map to the IAM role. | +| groups | typing.List[str] | A list of groups within Kubernetes to which the role is mapped. | +| username | str | The user name within Kubernetes to map to the IAM role. | --- -##### \`groups\`Required +##### \`groups\`Required \`\`\`python groups: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`username\`Optional +##### \`username\`Optional \`\`\`python username: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70682,21 +72770,21 @@ aws_eks.AwsAuthProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdkawseksawsauthpropspropertycluster)* | [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) | The EKS cluster to apply this configuration to. | +| cluster | Cluster | The EKS cluster to apply this configuration to. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: Cluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply this configuration to. @@ -70704,11 +72792,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70724,94 +72812,94 @@ aws_eks.BootstrapOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`additional_args\`](#awscdkawseksbootstrapoptionspropertyadditionalargs) | \`str\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`aws_api_retry_attempts\`](#awscdkawseksbootstrapoptionspropertyawsapiretryattempts) | \`typing.Union[int, float]\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`dns_cluster_ip\`](#awscdkawseksbootstrapoptionspropertydnsclusterip) | \`str\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`docker_config_json\`](#awscdkawseksbootstrapoptionspropertydockerconfigjson) | \`str\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`enable_docker_bridge\`](#awscdkawseksbootstrapoptionspropertyenabledockerbridge) | \`bool\` | Restores the docker default bridge network. | -| [\`kubelet_extra_args\`](#awscdkawseksbootstrapoptionspropertykubeletextraargs) | \`str\` | Extra arguments to add to the kubelet. | -| [\`use_max_pods\`](#awscdkawseksbootstrapoptionspropertyusemaxpods) | \`bool\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| additional_args | str | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| aws_api_retry_attempts | typing.Union[int, float] | Number of retry attempts for AWS API call (DescribeCluster). | +| dns_cluster_ip | str | Overrides the IP address to use for DNS queries within the cluster. | +| docker_config_json | str | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| enable_docker_bridge | bool | Restores the docker default bridge network. | +| kubelet_extra_args | str | Extra arguments to add to the kubelet. | +| use_max_pods | bool | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`additional_args\`Optional +##### \`additional_args\`Optional \`\`\`python additional_args: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`aws_api_retry_attempts\`Optional +##### \`aws_api_retry_attempts\`Optional \`\`\`python aws_api_retry_attempts: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`dns_cluster_ip\`Optional +##### \`dns_cluster_ip\`Optional \`\`\`python dns_cluster_ip: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`docker_config_json\`Optional +##### \`docker_config_json\`Optional \`\`\`python docker_config_json: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`enable_docker_bridge\`Optional +##### \`enable_docker_bridge\`Optional \`\`\`python enable_docker_bridge: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Restores the docker default bridge network. --- -##### \`kubelet_extra_args\`Optional +##### \`kubelet_extra_args\`Optional \`\`\`python kubelet_extra_args: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* none Extra arguments to add to the kubelet. @@ -70820,26 +72908,26 @@ Useful for adding labels or taints. --- -##### \`use_max_pods\`Optional +##### \`use_max_pods\`Optional \`\`\`python use_max_pods: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70854,26 +72942,26 @@ aws_eks.CfnAddonProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`addon_name\`](#awscdkawsekscfnaddonpropspropertyaddonname)* | \`str\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`cluster_name\`](#awscdkawsekscfnaddonpropspropertyclustername)* | \`str\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addon_version\`](#awscdkawsekscfnaddonpropspropertyaddonversion) | \`str\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolve_conflicts\`](#awscdkawsekscfnaddonpropspropertyresolveconflicts) | \`str\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`service_account_role_arn\`](#awscdkawsekscfnaddonpropspropertyserviceaccountrolearn) | \`str\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#awscdkawsekscfnaddonpropspropertytags) | typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] | \`AWS::EKS::Addon.Tags\`. | +| addon_name | str | \`AWS::EKS::Addon.AddonName\`. | +| cluster_name | str | \`AWS::EKS::Addon.ClusterName\`. | +| addon_version | str | \`AWS::EKS::Addon.AddonVersion\`. | +| resolve_conflicts | str | \`AWS::EKS::Addon.ResolveConflicts\`. | +| service_account_role_arn | str | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | typing.List[aws_cdk.CfnTag] | \`AWS::EKS::Addon.Tags\`. | --- -##### \`addon_name\`Required +##### \`addon_name\`Required \`\`\`python addon_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonName\`. @@ -70881,13 +72969,13 @@ addon_name: str --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ClusterName\`. @@ -70895,13 +72983,13 @@ cluster_name: str --- -##### \`addon_version\`Optional +##### \`addon_version\`Optional \`\`\`python addon_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.AddonVersion\`. @@ -70909,13 +72997,13 @@ addon_version: str --- -##### \`resolve_conflicts\`Optional +##### \`resolve_conflicts\`Optional \`\`\`python resolve_conflicts: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ResolveConflicts\`. @@ -70923,13 +73011,13 @@ resolve_conflicts: str --- -##### \`service_account_role_arn\`Optional +##### \`service_account_role_arn\`Optional \`\`\`python service_account_role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -70937,13 +73025,13 @@ service_account_role_arn: str --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] +- *Type:* typing.List[aws_cdk.CfnTag] \`AWS::EKS::Addon.Tags\`. @@ -70951,13 +73039,13 @@ tags: typing.List[CfnTag] --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -70972,26 +73060,26 @@ aws_eks.CfnClusterProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`resources_vpc_config\`](#awscdkawsekscfnclusterpropspropertyresourcesvpcconfig)* | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`role_arn\`](#awscdkawsekscfnclusterpropspropertyrolearn)* | \`str\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryption_config\`](#awscdkawsekscfnclusterpropspropertyencryptionconfig) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetes_network_config\`](#awscdkawsekscfnclusterpropspropertykubernetesnetworkconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#awscdkawsekscfnclusterpropspropertyname) | \`str\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#awscdkawsekscfnclusterpropspropertyversion) | \`str\` | \`AWS::EKS::Cluster.Version\`. | +| resources_vpc_config | typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| role_arn | str | \`AWS::EKS::Cluster.RoleArn\`. | +| encryption_config | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetes_network_config | typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | str | \`AWS::EKS::Cluster.Name\`. | +| version | str | \`AWS::EKS::Cluster.Version\`. | --- -##### \`resources_vpc_config\`Required +##### \`resources_vpc_config\`Required \`\`\`python resources_vpc_config: typing.Union[ResourcesVpcConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.ResourcesVpcConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ResourcesVpcConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -70999,13 +73087,13 @@ resources_vpc_config: typing.Union[ResourcesVpcConfigProperty, IResolvable] --- -##### \`role_arn\`Required +##### \`role_arn\`Required \`\`\`python role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.RoleArn\`. @@ -71013,13 +73101,13 @@ role_arn: str --- -##### \`encryption_config\`Optional +##### \`encryption_config\`Optional \`\`\`python encryption_config: typing.Union[IResolvable, typing.List[typing.Union[EncryptionConfigProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.EncryptionConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[EncryptionConfigProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -71027,13 +73115,13 @@ encryption_config: typing.Union[IResolvable, typing.List[typing.Union[Encryption --- -##### \`kubernetes_network_config\`Optional +##### \`kubernetes_network_config\`Optional \`\`\`python kubernetes_network_config: typing.Union[KubernetesNetworkConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws_cdk.aws_eks.CfnCluster.KubernetesNetworkConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[KubernetesNetworkConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -71041,13 +73129,13 @@ kubernetes_network_config: typing.Union[KubernetesNetworkConfigProperty, IResolv --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`python name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Name\`. @@ -71055,13 +73143,13 @@ name: str --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Cluster.Version\`. @@ -71069,13 +73157,13 @@ version: str --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -71090,26 +73178,26 @@ aws_eks.CfnFargateProfileProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster_name\`](#awscdkawsekscfnfargateprofilepropspropertyclustername)* | \`str\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`pod_execution_role_arn\`](#awscdkawsekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`str\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#awscdkawsekscfnfargateprofilepropspropertyselectors)* | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargate_profile_name\`](#awscdkawsekscfnfargateprofilepropspropertyfargateprofilename) | \`str\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#awscdkawsekscfnfargateprofilepropspropertysubnets) | typing.List[\`str\`] | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#awscdkawsekscfnfargateprofilepropspropertytags) | typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] | \`AWS::EKS::FargateProfile.Tags\`. | +| cluster_name | str | \`AWS::EKS::FargateProfile.ClusterName\`. | +| pod_execution_role_arn | str | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargate_profile_name | str | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | typing.List[str] | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | typing.List[aws_cdk.CfnTag] | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.ClusterName\`. @@ -71117,13 +73205,13 @@ cluster_name: str --- -##### \`pod_execution_role_arn\`Required +##### \`pod_execution_role_arn\`Required \`\`\`python pod_execution_role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -71131,13 +73219,13 @@ pod_execution_role_arn: str --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`python selectors: typing.Union[IResolvable, typing.List[typing.Union[SelectorProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.SelectorProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[SelectorProperty, aws_cdk.IResolvable]]] \`AWS::EKS::FargateProfile.Selectors\`. @@ -71145,13 +73233,13 @@ selectors: typing.Union[IResolvable, typing.List[typing.Union[SelectorProperty, --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional \`\`\`python fargate_profile_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -71159,13 +73247,13 @@ fargate_profile_name: str --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`python subnets: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::FargateProfile.Subnets\`. @@ -71173,13 +73261,13 @@ subnets: typing.List[str] --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.CfnTag\`](#aws_cdk.CfnTag)] +- *Type:* typing.List[aws_cdk.CfnTag] \`AWS::EKS::FargateProfile.Tags\`. @@ -71187,13 +73275,13 @@ tags: typing.List[CfnTag] --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -71219,37 +73307,37 @@ aws_eks.CfnNodegroupProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster_name\`](#awscdkawsekscfnnodegrouppropspropertyclustername)* | \`str\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`node_role\`](#awscdkawsekscfnnodegrouppropspropertynoderole)* | \`str\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#awscdkawsekscfnnodegrouppropspropertysubnets)* | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`ami_type\`](#awscdkawsekscfnnodegrouppropspropertyamitype) | \`str\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacity_type\`](#awscdkawsekscfnnodegrouppropspropertycapacitytype) | \`str\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`disk_size\`](#awscdkawsekscfnnodegrouppropspropertydisksize) | \`typing.Union[int, float]\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`force_update_enabled\`](#awscdkawsekscfnnodegrouppropspropertyforceupdateenabled) | typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instance_types\`](#awscdkawsekscfnnodegrouppropspropertyinstancetypes) | typing.List[\`str\`] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#awscdkawsekscfnnodegrouppropspropertylabels) | \`typing.Any\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launch_template\`](#awscdkawsekscfnnodegrouppropspropertylaunchtemplate) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroup_name\`](#awscdkawsekscfnnodegrouppropspropertynodegroupname) | \`str\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`release_version\`](#awscdkawsekscfnnodegrouppropspropertyreleaseversion) | \`str\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remote_access\`](#awscdkawsekscfnnodegrouppropspropertyremoteaccess) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scaling_config\`](#awscdkawsekscfnnodegrouppropspropertyscalingconfig) | typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#awscdkawsekscfnnodegrouppropspropertytags) | \`typing.Any\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#awscdkawsekscfnnodegrouppropspropertytaints) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#awscdkawsekscfnnodegrouppropspropertyversion) | \`str\` | \`AWS::EKS::Nodegroup.Version\`. | +| cluster_name | str | \`AWS::EKS::Nodegroup.ClusterName\`. | +| node_role | str | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | typing.List[str] | \`AWS::EKS::Nodegroup.Subnets\`. | +| ami_type | str | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacity_type | str | \`AWS::EKS::Nodegroup.CapacityType\`. | +| disk_size | typing.Union[int, float] | \`AWS::EKS::Nodegroup.DiskSize\`. | +| force_update_enabled | typing.Union[bool, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instance_types | typing.List[str] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | typing.Any | \`AWS::EKS::Nodegroup.Labels\`. | +| launch_template | typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroup_name | str | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| release_version | str | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remote_access | typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scaling_config | typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | typing.Any | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] | \`AWS::EKS::Nodegroup.Taints\`. | +| version | str | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ClusterName\`. @@ -71257,13 +73345,13 @@ cluster_name: str --- -##### \`node_role\`Required +##### \`node_role\`Required \`\`\`python node_role: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodeRole\`. @@ -71271,13 +73359,13 @@ node_role: str --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`python subnets: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.Subnets\`. @@ -71285,13 +73373,13 @@ subnets: typing.List[str] --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional \`\`\`python ami_type: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.AmiType\`. @@ -71299,13 +73387,13 @@ ami_type: str --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional \`\`\`python capacity_type: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.CapacityType\`. @@ -71313,13 +73401,13 @@ capacity_type: str --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional \`\`\`python disk_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`AWS::EKS::Nodegroup.DiskSize\`. @@ -71327,13 +73415,13 @@ disk_size: typing.Union[int, float] --- -##### \`force_update_enabled\`Optional +##### \`force_update_enabled\`Optional \`\`\`python force_update_enabled: typing.Union[bool, IResolvable] \`\`\` -- *Type:* typing.Union[\`bool\`, [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[bool, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -71341,13 +73429,13 @@ force_update_enabled: typing.Union[bool, IResolvable] --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional \`\`\`python instance_types: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -71355,13 +73443,13 @@ instance_types: typing.List[str] --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`python labels: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::EKS::Nodegroup.Labels\`. @@ -71369,13 +73457,13 @@ labels: typing.Any --- -##### \`launch_template\`Optional +##### \`launch_template\`Optional \`\`\`python launch_template: typing.Union[LaunchTemplateSpecificationProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws_cdk.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[LaunchTemplateSpecificationProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -71383,13 +73471,13 @@ launch_template: typing.Union[LaunchTemplateSpecificationProperty, IResolvable] --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -71397,13 +73485,13 @@ nodegroup_name: str --- -##### \`release_version\`Optional +##### \`release_version\`Optional \`\`\`python release_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -71411,13 +73499,13 @@ release_version: str --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional \`\`\`python remote_access: typing.Union[RemoteAccessProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws_cdk.aws_eks.CfnNodegroup.RemoteAccessProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[RemoteAccessProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -71425,13 +73513,13 @@ remote_access: typing.Union[RemoteAccessProperty, IResolvable] --- -##### \`scaling_config\`Optional +##### \`scaling_config\`Optional \`\`\`python scaling_config: typing.Union[ScalingConfigProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws_cdk.aws_eks.CfnNodegroup.ScalingConfigProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ScalingConfigProperty, aws_cdk.IResolvable] \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -71439,13 +73527,13 @@ scaling_config: typing.Union[ScalingConfigProperty, IResolvable] --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::EKS::Nodegroup.Tags\`. @@ -71453,13 +73541,13 @@ tags: typing.Any --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`python taints: typing.Union[IResolvable, typing.List[typing.Union[TaintProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnNodegroup.TaintProperty\`](#aws_cdk.aws_eks.CfnNodegroup.TaintProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[TaintProperty, aws_cdk.IResolvable]]] \`AWS::EKS::Nodegroup.Taints\`. @@ -71467,13 +73555,13 @@ taints: typing.Union[IResolvable, typing.List[typing.Union[TaintProperty, IResol --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::EKS::Nodegroup.Version\`. @@ -71481,11 +73569,11 @@ version: str --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -71509,112 +73597,112 @@ aws_eks.ClusterAttributes( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster_name\`](#awscdkawseksclusterattributespropertyclustername)* | \`str\` | The physical name of the Cluster. | -| [\`cluster_certificate_authority_data\`](#awscdkawseksclusterattributespropertyclustercertificateauthoritydata) | \`str\` | The certificate-authority-data for your cluster. | -| [\`cluster_encryption_config_key_arn\`](#awscdkawseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`str\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`cluster_endpoint\`](#awscdkawseksclusterattributespropertyclusterendpoint) | \`str\` | The API Server endpoint URL. | -| [\`cluster_security_group_id\`](#awscdkawseksclusterattributespropertyclustersecuritygroupid) | \`str\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`kubectl_environment\`](#awscdkawseksclusterattributespropertykubectlenvironment) | typing.Mapping[\`str\`] | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`kubectl_layer\`](#awscdkawseksclusterattributespropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksclusterattributespropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectl_private_subnet_ids\`](#awscdkawseksclusterattributespropertykubectlprivatesubnetids) | typing.List[\`str\`] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectl_role_arn\`](#awscdkawseksclusterattributespropertykubectlrolearn) | \`str\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`kubectl_security_group_id\`](#awscdkawseksclusterattributespropertykubectlsecuritygroupid) | \`str\` | A security group to use for \`kubectl\` execution. | -| [\`open_id_connect_provider\`](#awscdkawseksclusterattributespropertyopenidconnectprovider) | [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`prune\`](#awscdkawseksclusterattributespropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`security_group_ids\`](#awscdkawseksclusterattributespropertysecuritygroupids) | typing.List[\`str\`] | Additional security groups associated with this cluster. | -| [\`vpc\`](#awscdkawseksclusterattributespropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which this Cluster was created. | +| cluster_name | str | The physical name of the Cluster. | +| cluster_certificate_authority_data | str | The certificate-authority-data for your cluster. | +| cluster_encryption_config_key_arn | str | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| cluster_endpoint | str | The API Server endpoint URL. | +| cluster_security_group_id | str | The cluster security group that was created by Amazon EKS for the cluster. | +| kubectl_environment | typing.Mapping[str] | Environment variables to use when running \`kubectl\` against this cluster. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectl_private_subnet_ids | typing.List[str] | Subnets to host the \`kubectl\` compute resources. | +| kubectl_role_arn | str | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| kubectl_security_group_id | str | A security group to use for \`kubectl\` execution. | +| open_id_connect_provider | aws_cdk.aws_iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| security_group_ids | typing.List[str] | Additional security groups associated with this cluster. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The physical name of the Cluster. --- -##### \`cluster_certificate_authority_data\`Optional +##### \`cluster_certificate_authority_data\`Optional \`\`\`python cluster_certificate_authority_data: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`cluster_encryption_config_key_arn\`Optional +##### \`cluster_encryption_config_key_arn\`Optional \`\`\`python cluster_encryption_config_key_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`cluster_endpoint\`Optional +##### \`cluster_endpoint\`Optional \`\`\`python cluster_endpoint: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`cluster_security_group_id\`Optional +##### \`cluster_security_group_id\`Optional \`\`\`python cluster_security_group_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -71623,26 +73711,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectl_private_subnet_ids\`Optional +##### \`kubectl_private_subnet_ids\`Optional \`\`\`python kubectl_private_subnet_ids: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -71651,26 +73739,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectl_role_arn\`Optional +##### \`kubectl_role_arn\`Optional \`\`\`python kubectl_role_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`kubectl_security_group_id\`Optional +##### \`kubectl_security_group_id\`Optional \`\`\`python kubectl_security_group_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -71679,13 +73767,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`open_id_connect_provider\`Optional +##### \`open_id_connect_provider\`Optional \`\`\`python open_id_connect_provider: IOpenIdConnectProvider \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) +- *Type:* aws_cdk.aws_iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -71694,13 +73782,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -71709,37 +73797,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`security_group_ids\`Optional +##### \`security_group_ids\`Optional \`\`\`python security_group_ids: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -71767,77 +73855,77 @@ aws_eks.ClusterOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdkawseksclusteroptionspropertyversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawseksclusteroptionspropertyclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawseksclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawseksclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawseksclusteroptionspropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawseksclusteroptionspropertysecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawseksclusteroptionspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawseksclusteroptionspropertyvpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | -| [\`cluster_handler_environment\`](#awscdkawseksclusteroptionspropertyclusterhandlerenvironment) | typing.Mapping[\`str\`] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`core_dns_compute_type\`](#awscdkawseksclusteroptionspropertycorednscomputetype) | [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpoint_access\`](#awscdkawseksclusteroptionspropertyendpointaccess) | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectl_environment\`](#awscdkawseksclusteroptionspropertykubectlenvironment) | typing.Mapping[\`str\`] | Environment variables for the kubectl execution. | -| [\`kubectl_layer\`](#awscdkawseksclusteroptionspropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksclusteroptionspropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`masters_role\`](#awscdkawseksclusteroptionspropertymastersrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`output_masters_role_arn\`](#awscdkawseksclusteroptionspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`place_cluster_handler_in_vpc\`](#awscdkawseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdkawseksclusteroptionspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secrets_encryption_key\`](#awscdkawseksclusteroptionspropertysecretsencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | +| cluster_handler_environment | typing.Mapping[str] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| core_dns_compute_type | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpoint_access | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectl_environment | typing.Mapping[str] | Environment variables for the kubectl execution. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| masters_role | aws_cdk.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| output_masters_role_arn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| place_cluster_handler_in_vpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secrets_encryption_key | aws_cdk.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: KubernetesVersion \`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional \`\`\`python output_cluster_name: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional \`\`\`python output_config_command: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -71846,52 +73934,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional \`\`\`python security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: typing.List[SubnetSelection] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -71900,54 +73988,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`cluster_handler_environment\`Optional +##### \`cluster_handler_environment\`Optional \`\`\`python cluster_handler_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`core_dns_compute_type\`Optional +##### \`core_dns_compute_type\`Optional \`\`\`python core_dns_compute_type: CoreDnsComputeType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpoint_access\`Optional +##### \`endpoint_access\`Optional \`\`\`python endpoint_access: EndpointAccess \`\`\` -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -71956,84 +74044,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`python # Example automatically generated from non-compiling source. May contain errors. layer = lambda_.LayerVersion(self, \\"kubectl-layer\\", code=lambda_.Code.from_asset(f\\"{__dirname}/layer.zip\\") )# compatible_runtimes: [lambda.Runtime.PROVIDED] \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`masters_role\`Optional +##### \`masters_role\`Optional \`\`\`python masters_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`output_masters_role_arn\`Optional +##### \`output_masters_role_arn\`Optional \`\`\`python output_masters_role_arn: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`place_cluster_handler_in_vpc\`Optional +##### \`place_cluster_handler_in_vpc\`Optional \`\`\`python place_cluster_handler_in_vpc: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -72042,24 +74130,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secrets_encryption_key\`Optional +##### \`secrets_encryption_key\`Optional \`\`\`python secrets_encryption_key: IKey \`\`\` -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -72090,80 +74178,80 @@ aws_eks.ClusterProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdkawseksclusterpropspropertyversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawseksclusterpropspropertyclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawseksclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawseksclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawseksclusterpropspropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawseksclusterpropspropertysecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawseksclusterpropspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawseksclusterpropspropertyvpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | -| [\`cluster_handler_environment\`](#awscdkawseksclusterpropspropertyclusterhandlerenvironment) | typing.Mapping[\`str\`] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`core_dns_compute_type\`](#awscdkawseksclusterpropspropertycorednscomputetype) | [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpoint_access\`](#awscdkawseksclusterpropspropertyendpointaccess) | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectl_environment\`](#awscdkawseksclusterpropspropertykubectlenvironment) | typing.Mapping[\`str\`] | Environment variables for the kubectl execution. | -| [\`kubectl_layer\`](#awscdkawseksclusterpropspropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksclusterpropspropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`masters_role\`](#awscdkawseksclusterpropspropertymastersrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`output_masters_role_arn\`](#awscdkawseksclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`place_cluster_handler_in_vpc\`](#awscdkawseksclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdkawseksclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secrets_encryption_key\`](#awscdkawseksclusterpropspropertysecretsencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`default_capacity\`](#awscdkawseksclusterpropspropertydefaultcapacity) | \`typing.Union[int, float]\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`default_capacity_instance\`](#awscdkawseksclusterpropspropertydefaultcapacityinstance) | [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`default_capacity_type\`](#awscdkawseksclusterpropspropertydefaultcapacitytype) | [\`aws_cdk.aws_eks.DefaultCapacityType\`](#aws_cdk.aws_eks.DefaultCapacityType) | The default capacity type for the cluster. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | +| cluster_handler_environment | typing.Mapping[str] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| core_dns_compute_type | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpoint_access | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectl_environment | typing.Mapping[str] | Environment variables for the kubectl execution. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| masters_role | aws_cdk.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| output_masters_role_arn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| place_cluster_handler_in_vpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secrets_encryption_key | aws_cdk.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| default_capacity | typing.Union[int, float] | Number of instances to allocate as an initial capacity for this cluster. | +| default_capacity_instance | aws_cdk.aws_ec2.InstanceType | The instance type to use for the default capacity. | +| default_capacity_type | DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: KubernetesVersion \`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional \`\`\`python output_cluster_name: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional \`\`\`python output_config_command: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -72172,52 +74260,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional \`\`\`python security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: typing.List[SubnetSelection] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -72226,54 +74314,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`cluster_handler_environment\`Optional +##### \`cluster_handler_environment\`Optional \`\`\`python cluster_handler_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`core_dns_compute_type\`Optional +##### \`core_dns_compute_type\`Optional \`\`\`python core_dns_compute_type: CoreDnsComputeType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpoint_access\`Optional +##### \`endpoint_access\`Optional \`\`\`python endpoint_access: EndpointAccess \`\`\` -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -72282,84 +74370,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`python # Example automatically generated from non-compiling source. May contain errors. layer = lambda_.LayerVersion(self, \\"kubectl-layer\\", code=lambda_.Code.from_asset(f\\"{__dirname}/layer.zip\\") )# compatible_runtimes: [lambda.Runtime.PROVIDED] \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`masters_role\`Optional +##### \`masters_role\`Optional \`\`\`python masters_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`output_masters_role_arn\`Optional +##### \`output_masters_role_arn\`Optional \`\`\`python output_masters_role_arn: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`place_cluster_handler_in_vpc\`Optional +##### \`place_cluster_handler_in_vpc\`Optional \`\`\`python place_cluster_handler_in_vpc: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -72368,26 +74456,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secrets_encryption_key\`Optional +##### \`secrets_encryption_key\`Optional \`\`\`python secrets_encryption_key: IKey \`\`\` -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`default_capacity\`Optional +##### \`default_capacity\`Optional \`\`\`python default_capacity: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -72396,13 +74484,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`default_capacity_instance\`Optional +##### \`default_capacity_instance\`Optional \`\`\`python default_capacity_instance: InstanceType \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType) +- *Type:* aws_cdk.aws_ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -72411,24 +74499,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`default_capacity_type\`Optional +##### \`default_capacity_type\`Optional \`\`\`python default_capacity_type: DefaultCapacityType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.DefaultCapacityType\`](#aws_cdk.aws_eks.DefaultCapacityType) +- *Type:* DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -72445,66 +74533,66 @@ aws_eks.CommonClusterOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdkawsekscommonclusteroptionspropertyversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawsekscommonclusteroptionspropertyclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawsekscommonclusteroptionspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawsekscommonclusteroptionspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawsekscommonclusteroptionspropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawsekscommonclusteroptionspropertysecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawsekscommonclusteroptionspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawsekscommonclusteroptionspropertyvpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: KubernetesVersion \`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional \`\`\`python output_cluster_name: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional \`\`\`python output_config_command: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -72513,52 +74601,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional \`\`\`python security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: typing.List[SubnetSelection] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -72567,11 +74655,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -72583,60 +74671,60 @@ aws_eks.EksOptimizedImageProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpu_arch\`](#awscdkawsekseksoptimizedimagepropspropertycpuarch) | [\`aws_cdk.aws_eks.CpuArch\`](#aws_cdk.aws_eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetes_version\`](#awscdkawsekseksoptimizedimagepropspropertykubernetesversion) | \`str\` | The Kubernetes version to use. | -| [\`node_type\`](#awscdkawsekseksoptimizedimagepropspropertynodetype) | [\`aws_cdk.aws_eks.NodeType\`](#aws_cdk.aws_eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpu_arch | CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetes_version | str | The Kubernetes version to use. | +| node_type | NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpu_arch\`Optional +##### \`cpu_arch\`Optional \`\`\`python cpu_arch: CpuArch \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CpuArch\`](#aws_cdk.aws_eks.CpuArch) +- *Type:* CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetes_version\`Optional +##### \`kubernetes_version\`Optional \`\`\`python kubernetes_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* The latest version The Kubernetes version to use. --- -##### \`node_type\`Optional +##### \`node_type\`Optional \`\`\`python node_type: NodeType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.NodeType\`](#aws_cdk.aws_eks.NodeType) +- *Type:* NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -72647,22 +74735,22 @@ aws_eks.CfnCluster.EncryptionConfigProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`provider\`](#awscdkawsekscfnclusterencryptionconfigpropertypropertyprovider) | typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ProviderProperty\`](#aws_cdk.aws_eks.CfnCluster.ProviderProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`resources\`](#awscdkawsekscfnclusterencryptionconfigpropertypropertyresources) | typing.List[\`str\`] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| provider | typing.Union[ProviderProperty, aws_cdk.IResolvable] | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| resources | typing.List[str] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`provider\`Optional +##### \`provider\`Optional \`\`\`python provider: typing.Union[ProviderProperty, IResolvable] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.aws_eks.CfnCluster.ProviderProperty\`](#aws_cdk.aws_eks.CfnCluster.ProviderProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)] +- *Type:* typing.Union[ProviderProperty, aws_cdk.IResolvable] \`CfnCluster.EncryptionConfigProperty.Provider\`. @@ -72670,13 +74758,13 @@ provider: typing.Union[ProviderProperty, IResolvable] --- -##### \`resources\`Optional +##### \`resources\`Optional \`\`\`python resources: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -72684,11 +74772,11 @@ resources: typing.List[str] --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -72717,78 +74805,78 @@ aws_eks.FargateClusterProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdkawseksfargateclusterpropspropertyversion)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`cluster_name\`](#awscdkawseksfargateclusterpropspropertyclustername) | \`str\` | Name for the cluster. | -| [\`output_cluster_name\`](#awscdkawseksfargateclusterpropspropertyoutputclustername) | \`bool\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`output_config_command\`](#awscdkawseksfargateclusterpropspropertyoutputconfigcommand) | \`bool\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdkawseksfargateclusterpropspropertyrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`security_group\`](#awscdkawseksfargateclusterpropspropertysecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdkawseksfargateclusterpropspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpc_subnets\`](#awscdkawseksfargateclusterpropspropertyvpcsubnets) | typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] | Where to place EKS Control Plane ENIs. | -| [\`cluster_handler_environment\`](#awscdkawseksfargateclusterpropspropertyclusterhandlerenvironment) | typing.Mapping[\`str\`] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`core_dns_compute_type\`](#awscdkawseksfargateclusterpropspropertycorednscomputetype) | [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpoint_access\`](#awscdkawseksfargateclusterpropspropertyendpointaccess) | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectl_environment\`](#awscdkawseksfargateclusterpropspropertykubectlenvironment) | typing.Mapping[\`str\`] | Environment variables for the kubectl execution. | -| [\`kubectl_layer\`](#awscdkawseksfargateclusterpropspropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectl_memory\`](#awscdkawseksfargateclusterpropspropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`masters_role\`](#awscdkawseksfargateclusterpropspropertymastersrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`output_masters_role_arn\`](#awscdkawseksfargateclusterpropspropertyoutputmastersrolearn) | \`bool\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`place_cluster_handler_in_vpc\`](#awscdkawseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`bool\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdkawseksfargateclusterpropspropertyprune) | \`bool\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secrets_encryption_key\`](#awscdkawseksfargateclusterpropspropertysecretsencryptionkey) | [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`default_profile\`](#awscdkawseksfargateclusterpropspropertydefaultprofile) | [\`aws_cdk.aws_eks.FargateProfileOptions\`](#aws_cdk.aws_eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| cluster_name | str | Name for the cluster. | +| output_cluster_name | bool | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| output_config_command | bool | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws_cdk.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| security_group | aws_cdk.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpc_subnets | typing.List[aws_cdk.aws_ec2.SubnetSelection] | Where to place EKS Control Plane ENIs. | +| cluster_handler_environment | typing.Mapping[str] | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| core_dns_compute_type | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpoint_access | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectl_environment | typing.Mapping[str] | Environment variables for the kubectl execution. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| masters_role | aws_cdk.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| output_masters_role_arn | bool | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| place_cluster_handler_in_vpc | bool | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | bool | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secrets_encryption_key | aws_cdk.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| default_profile | FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: KubernetesVersion \`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`cluster_name\`Optional +##### \`cluster_name\`Optional \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* Automatically generated name Name for the cluster. --- -##### \`output_cluster_name\`Optional +##### \`output_cluster_name\`Optional \`\`\`python output_cluster_name: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`output_config_command\`Optional +##### \`output_config_command\`Optional \`\`\`python output_config_command: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -72797,52 +74885,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`python role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`security_group\`Optional +##### \`security_group\`Optional \`\`\`python security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpc_subnets\`Optional +##### \`vpc_subnets\`Optional \`\`\`python vpc_subnets: typing.List[SubnetSelection] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection)] +- *Type:* typing.List[aws_cdk.aws_ec2.SubnetSelection] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -72851,54 +74939,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`cluster_handler_environment\`Optional +##### \`cluster_handler_environment\`Optional \`\`\`python cluster_handler_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`core_dns_compute_type\`Optional +##### \`core_dns_compute_type\`Optional \`\`\`python core_dns_compute_type: CoreDnsComputeType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CoreDnsComputeType\`](#aws_cdk.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpoint_access\`Optional +##### \`endpoint_access\`Optional \`\`\`python endpoint_access: EndpointAccess \`\`\` -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -72907,84 +74995,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`python # Example automatically generated from non-compiling source. May contain errors. layer = lambda_.LayerVersion(self, \\"kubectl-layer\\", code=lambda_.Code.from_asset(f\\"{__dirname}/layer.zip\\") )# compatible_runtimes: [lambda.Runtime.PROVIDED] \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`masters_role\`Optional +##### \`masters_role\`Optional \`\`\`python masters_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`output_masters_role_arn\`Optional +##### \`output_masters_role_arn\`Optional \`\`\`python output_masters_role_arn: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`place_cluster_handler_in_vpc\`Optional +##### \`place_cluster_handler_in_vpc\`Optional \`\`\`python place_cluster_handler_in_vpc: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -72993,37 +75081,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secrets_encryption_key\`Optional +##### \`secrets_encryption_key\`Optional \`\`\`python secrets_encryption_key: IKey \`\`\` -- *Type:* [\`aws_cdk.aws_kms.IKey\`](#aws_cdk.aws_kms.IKey) +- *Type:* aws_cdk.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`default_profile\`Optional +##### \`default_profile\`Optional \`\`\`python default_profile: FargateProfileOptions \`\`\` -- *Type:* [\`aws_cdk.aws_eks.FargateProfileOptions\`](#aws_cdk.aws_eks.FargateProfileOptions) +- *Type:* FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73037,25 +75125,25 @@ aws_eks.FargateProfileOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#awscdkawseksfargateprofileoptionspropertyselectors)* | typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] | The selectors to match for pods to use this Fargate profile. | -| [\`fargate_profile_name\`](#awscdkawseksfargateprofileoptionspropertyfargateprofilename) | \`str\` | The name of the Fargate profile. | -| [\`pod_execution_role\`](#awscdkawseksfargateprofileoptionspropertypodexecutionrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnet_selection\`](#awscdkawseksfargateprofileoptionspropertysubnetselection) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#awscdkawseksfargateprofileoptionspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| selectors | typing.List[Selector] | The selectors to match for pods to use this Fargate profile. | +| fargate_profile_name | str | The name of the Fargate profile. | +| pod_execution_role | aws_cdk.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnet_selection | aws_cdk.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`python selectors: typing.List[Selector] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] +- *Type:* typing.List[Selector] The selectors to match for pods to use this Fargate profile. @@ -73063,43 +75151,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional \`\`\`python fargate_profile_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* generated The name of the Fargate profile. --- -##### \`pod_execution_role\`Optional +##### \`pod_execution_role\`Optional \`\`\`python pod_execution_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnet_selection\`Optional +##### \`subnet_selection\`Optional \`\`\`python subnet_selection: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -73108,13 +75196,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -73123,11 +75211,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73142,26 +75230,26 @@ aws_eks.FargateProfileProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#awscdkawseksfargateprofilepropspropertyselectors)* | typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] | The selectors to match for pods to use this Fargate profile. | -| [\`fargate_profile_name\`](#awscdkawseksfargateprofilepropspropertyfargateprofilename) | \`str\` | The name of the Fargate profile. | -| [\`pod_execution_role\`](#awscdkawseksfargateprofilepropspropertypodexecutionrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnet_selection\`](#awscdkawseksfargateprofilepropspropertysubnetselection) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#awscdkawseksfargateprofilepropspropertyvpc) | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#awscdkawseksfargateprofilepropspropertycluster)* | [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| selectors | typing.List[Selector] | The selectors to match for pods to use this Fargate profile. | +| fargate_profile_name | str | The name of the Fargate profile. | +| pod_execution_role | aws_cdk.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnet_selection | aws_cdk.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`python selectors: typing.List[Selector] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_eks.Selector\`](#aws_cdk.aws_eks.Selector)] +- *Type:* typing.List[Selector] The selectors to match for pods to use this Fargate profile. @@ -73169,43 +75257,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargate_profile_name\`Optional +##### \`fargate_profile_name\`Optional \`\`\`python fargate_profile_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* generated The name of the Fargate profile. --- -##### \`pod_execution_role\`Optional +##### \`pod_execution_role\`Optional \`\`\`python pod_execution_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnet_selection\`Optional +##### \`subnet_selection\`Optional \`\`\`python subnet_selection: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -73214,13 +75302,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -73229,13 +75317,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: Cluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply the Fargate profile to. @@ -73243,11 +75331,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73265,80 +75353,80 @@ aws_eks.HelmChartOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#awscdkawsekshelmchartoptionspropertychart)* | \`str\` | The name of the chart. | -| [\`create_namespace\`](#awscdkawsekshelmchartoptionspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`namespace\`](#awscdkawsekshelmchartoptionspropertynamespace) | \`str\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#awscdkawsekshelmchartoptionspropertyrelease) | \`str\` | The name of the release. | -| [\`repository\`](#awscdkawsekshelmchartoptionspropertyrepository) | \`str\` | The repository which contains the chart. | -| [\`timeout\`](#awscdkawsekshelmchartoptionspropertytimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#awscdkawsekshelmchartoptionspropertyvalues) | typing.Mapping[\`typing.Any\`] | The values to be used by the chart. | -| [\`version\`](#awscdkawsekshelmchartoptionspropertyversion) | \`str\` | The chart version to install. | -| [\`wait\`](#awscdkawsekshelmchartoptionspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| chart | str | The name of the chart. | +| create_namespace | bool | create namespace if not exist. | +| namespace | str | The Kubernetes namespace scope of the requests. | +| release | str | The name of the release. | +| repository | str | The repository which contains the chart. | +| timeout | aws_cdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | typing.Mapping[typing.Any] | The values to be used by the chart. | +| version | str | The chart version to install. | +| wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`python chart: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the chart. --- -##### \`create_namespace\`Optional +##### \`create_namespace\`Optional \`\`\`python create_namespace: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`python release: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`python repository: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -73347,13 +75435,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`python timeout: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -73362,50 +75450,50 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`python values: typing.Mapping[typing.Any] \`\`\` -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`python wait: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73424,81 +75512,81 @@ aws_eks.HelmChartProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#awscdkawsekshelmchartpropspropertychart)* | \`str\` | The name of the chart. | -| [\`create_namespace\`](#awscdkawsekshelmchartpropspropertycreatenamespace) | \`bool\` | create namespace if not exist. | -| [\`namespace\`](#awscdkawsekshelmchartpropspropertynamespace) | \`str\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#awscdkawsekshelmchartpropspropertyrelease) | \`str\` | The name of the release. | -| [\`repository\`](#awscdkawsekshelmchartpropspropertyrepository) | \`str\` | The repository which contains the chart. | -| [\`timeout\`](#awscdkawsekshelmchartpropspropertytimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#awscdkawsekshelmchartpropspropertyvalues) | typing.Mapping[\`typing.Any\`] | The values to be used by the chart. | -| [\`version\`](#awscdkawsekshelmchartpropspropertyversion) | \`str\` | The chart version to install. | -| [\`wait\`](#awscdkawsekshelmchartpropspropertywait) | \`bool\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#awscdkawsekshelmchartpropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to apply this configuration to. | +| chart | str | The name of the chart. | +| create_namespace | bool | create namespace if not exist. | +| namespace | str | The Kubernetes namespace scope of the requests. | +| release | str | The name of the release. | +| repository | str | The repository which contains the chart. | +| timeout | aws_cdk.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | typing.Mapping[typing.Any] | The values to be used by the chart. | +| version | str | The chart version to install. | +| wait | bool | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | ICluster | The EKS cluster to apply this configuration to. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`python chart: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the chart. --- -##### \`create_namespace\`Optional +##### \`create_namespace\`Optional \`\`\`python create_namespace: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`python release: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`python repository: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -73507,13 +75595,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`python timeout: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -73522,52 +75610,52 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`python values: typing.Mapping[typing.Any] \`\`\` -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`python wait: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this configuration to. @@ -73575,11 +75663,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73590,50 +75678,50 @@ aws_eks.KubernetesManifestOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#awscdkawsekskubernetesmanifestoptionspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skip_validation\`](#awscdkawsekskubernetesmanifestoptionspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | +| prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skip_validation | bool | A flag to signify if the manifest validation should be skipped. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skip_validation\`Optional +##### \`skip_validation\`Optional \`\`\`python skip_validation: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73647,55 +75735,55 @@ aws_eks.KubernetesManifestProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#awscdkawsekskubernetesmanifestpropspropertyprune) | \`bool\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skip_validation\`](#awscdkawsekskubernetesmanifestpropspropertyskipvalidation) | \`bool\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#awscdkawsekskubernetesmanifestpropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#awscdkawsekskubernetesmanifestpropspropertymanifest)* | typing.List[typing.Mapping[\`typing.Any\`]] | The manifest to apply. | -| [\`overwrite\`](#awscdkawsekskubernetesmanifestpropspropertyoverwrite) | \`bool\` | Overwrite any existing resources. | +| prune | bool | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skip_validation | bool | A flag to signify if the manifest validation should be skipped. | +| cluster | ICluster | The EKS cluster to apply this manifest to. | +| manifest | typing.List[typing.Mapping[typing.Any]] | The manifest to apply. | +| overwrite | bool | Overwrite any existing resources. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skip_validation\`Optional +##### \`skip_validation\`Optional \`\`\`python skip_validation: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this manifest to. @@ -73703,13 +75791,13 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required \`\`\`python manifest: typing.List[typing.Mapping[typing.Any]] \`\`\` -- *Type:* typing.List[typing.Mapping[\`typing.Any\`]] +- *Type:* typing.List[typing.Mapping[typing.Any]] The manifest to apply. @@ -73717,13 +75805,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional \`\`\`python overwrite: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* false Overwrite any existing resources. @@ -73732,11 +75820,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73746,21 +75834,21 @@ aws_eks.CfnCluster.KubernetesNetworkConfigProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`service_ipv4_cidr\`](#awscdkawsekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`str\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| service_ipv4_cidr | str | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`service_ipv4_cidr\`Optional +##### \`service_ipv4_cidr\`Optional \`\`\`python service_ipv4_cidr: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -73768,11 +75856,11 @@ service_ipv4_cidr: str --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73787,26 +75875,26 @@ aws_eks.KubernetesObjectValueProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdkawsekskubernetesobjectvaluepropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`json_path\`](#awscdkawsekskubernetesobjectvaluepropspropertyjsonpath)* | \`str\` | JSONPath to the specific value. | -| [\`object_name\`](#awscdkawsekskubernetesobjectvaluepropspropertyobjectname)* | \`str\` | The name of the object to query. | -| [\`object_type\`](#awscdkawsekskubernetesobjectvaluepropspropertyobjecttype)* | \`str\` | The object type to query. | -| [\`object_namespace\`](#awscdkawsekskubernetesobjectvaluepropspropertyobjectnamespace) | \`str\` | The namespace the object belongs to. | -| [\`timeout\`](#awscdkawsekskubernetesobjectvaluepropspropertytimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Timeout for waiting on a value. | +| cluster | ICluster | The EKS cluster to fetch attributes from. | +| json_path | str | JSONPath to the specific value. | +| object_name | str | The name of the object to query. | +| object_type | str | The object type to query. | +| object_namespace | str | The namespace the object belongs to. | +| timeout | aws_cdk.Duration | Timeout for waiting on a value. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to fetch attributes from. @@ -73814,39 +75902,39 @@ The EKS cluster to fetch attributes from. --- -##### \`json_path\`Required +##### \`json_path\`Required \`\`\`python json_path: str \`\`\` -- *Type:* \`str\` +- *Type:* str JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`object_name\`Required +##### \`object_name\`Required \`\`\`python object_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the object to query. --- -##### \`object_type\`Required +##### \`object_type\`Required \`\`\`python object_type: str \`\`\` -- *Type:* \`str\` +- *Type:* str The object type to query. @@ -73854,37 +75942,37 @@ The object type to query. --- -##### \`object_namespace\`Optional +##### \`object_namespace\`Optional \`\`\`python object_namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`python timeout: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -73899,38 +75987,38 @@ aws_eks.KubernetesPatchProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`apply_patch\`](#awscdkawsekskubernetespatchpropspropertyapplypatch)* | typing.Mapping[\`typing.Any\`] | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#awscdkawsekskubernetespatchpropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The cluster to apply the patch to. | -| [\`resource_name\`](#awscdkawsekskubernetespatchpropspropertyresourcename)* | \`str\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restore_patch\`](#awscdkawsekskubernetespatchpropspropertyrestorepatch)* | typing.Mapping[\`typing.Any\`] | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patch_type\`](#awscdkawsekskubernetespatchpropspropertypatchtype) | [\`aws_cdk.aws_eks.PatchType\`](#aws_cdk.aws_eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resource_namespace\`](#awscdkawsekskubernetespatchpropspropertyresourcenamespace) | \`str\` | The kubernetes API namespace. | +| apply_patch | typing.Mapping[typing.Any] | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | ICluster | The cluster to apply the patch to. | +| resource_name | str | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restore_patch | typing.Mapping[typing.Any] | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patch_type | PatchType | The patch type to pass to \`kubectl patch\`. | +| resource_namespace | str | The kubernetes API namespace. | --- -##### \`apply_patch\`Required +##### \`apply_patch\`Required \`\`\`python apply_patch: typing.Mapping[typing.Any] \`\`\` -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. @@ -73938,37 +76026,37 @@ The cluster to apply the patch to. --- -##### \`resource_name\`Required +##### \`resource_name\`Required \`\`\`python resource_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restore_patch\`Required +##### \`restore_patch\`Required \`\`\`python restore_patch: typing.Mapping[typing.Any] \`\`\` -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patch_type\`Optional +##### \`patch_type\`Optional \`\`\`python patch_type: PatchType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.PatchType\`](#aws_cdk.aws_eks.PatchType) +- *Type:* PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -73977,24 +76065,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resource_namespace\`Optional +##### \`resource_namespace\`Optional \`\`\`python resource_namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74005,22 +76093,22 @@ aws_eks.CfnFargateProfile.LabelProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`key\`](#awscdkawsekscfnfargateprofilelabelpropertypropertykey)* | \`str\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`value\`](#awscdkawsekscfnfargateprofilelabelpropertypropertyvalue)* | \`str\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| key | str | \`CfnFargateProfile.LabelProperty.Key\`. | +| value | str | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`key\`Required +##### \`key\`Required \`\`\`python key: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnFargateProfile.LabelProperty.Key\`. @@ -74028,13 +76116,13 @@ key: str --- -##### \`value\`Required +##### \`value\`Required \`\`\`python value: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnFargateProfile.LabelProperty.Value\`. @@ -74042,11 +76130,11 @@ value: str --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74057,45 +76145,45 @@ aws_eks.LaunchTemplateSpec( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#awscdkawsekslaunchtemplatespecpropertyid)* | \`str\` | The Launch template ID. | -| [\`version\`](#awscdkawsekslaunchtemplatespecpropertyversion) | \`str\` | The launch template version to be used (optional). | +| id | str | The Launch template ID. | +| version | str | The launch template version to be used (optional). | --- -##### \`id\`Required +##### \`id\`Required \`\`\`python id: str \`\`\` -- *Type:* \`str\` +- *Type:* str The Launch template ID. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74107,23 +76195,23 @@ aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#awscdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`str\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`name\`](#awscdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`str\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`version\`](#awscdkawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`str\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| id | str | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| name | str | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| version | str | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`id\`Optional +##### \`id\`Optional \`\`\`python id: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -74131,13 +76219,13 @@ id: str --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`python name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -74145,13 +76233,13 @@ name: str --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -74159,11 +76247,11 @@ version: str --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74188,62 +76276,62 @@ aws_eks.NodegroupOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ami_type\`](#awscdkawseksnodegroupoptionspropertyamitype) | [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacity_type\`](#awscdkawseksnodegroupoptionspropertycapacitytype) | [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desired_size\`](#awscdkawseksnodegroupoptionspropertydesiredsize) | \`typing.Union[int, float]\` | The current number of worker nodes that the managed node group should maintain. | -| [\`disk_size\`](#awscdkawseksnodegroupoptionspropertydisksize) | \`typing.Union[int, float]\` | The root device disk size (in GiB) for your node group instances. | -| [\`force_update\`](#awscdkawseksnodegroupoptionspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instance_types\`](#awscdkawseksnodegroupoptionspropertyinstancetypes) | typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] | The instance types to use for your node group. | -| [\`labels\`](#awscdkawseksnodegroupoptionspropertylabels) | typing.Mapping[\`str\`] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launch_template_spec\`](#awscdkawseksnodegroupoptionspropertylaunchtemplatespec) | [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`max_size\`](#awscdkawseksnodegroupoptionspropertymaxsize) | \`typing.Union[int, float]\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`min_size\`](#awscdkawseksnodegroupoptionspropertyminsize) | \`typing.Union[int, float]\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroup_name\`](#awscdkawseksnodegroupoptionspropertynodegroupname) | \`str\` | Name of the Nodegroup. | -| [\`node_role\`](#awscdkawseksnodegroupoptionspropertynoderole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`release_version\`](#awscdkawseksnodegroupoptionspropertyreleaseversion) | \`str\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remote_access\`](#awscdkawseksnodegroupoptionspropertyremoteaccess) | [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#awscdkawseksnodegroupoptionspropertysubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#awscdkawseksnodegroupoptionspropertytags) | typing.Mapping[\`str\`] | The metadata to apply to the node group to assist with categorization and organization. | +| ami_type | NodegroupAmiType | The AMI type for your node group. | +| capacity_type | CapacityType | The capacity type of the nodegroup. | +| desired_size | typing.Union[int, float] | The current number of worker nodes that the managed node group should maintain. | +| disk_size | typing.Union[int, float] | The root device disk size (in GiB) for your node group instances. | +| force_update | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instance_types | typing.List[aws_cdk.aws_ec2.InstanceType] | The instance types to use for your node group. | +| labels | typing.Mapping[str] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launch_template_spec | LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| max_size | typing.Union[int, float] | The maximum number of worker nodes that the managed node group can scale out to. | +| min_size | typing.Union[int, float] | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroup_name | str | Name of the Nodegroup. | +| node_role | aws_cdk.aws_iam.IRole | The IAM role to associate with your node group. | +| release_version | str | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remote_access | NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | aws_cdk.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | typing.Mapping[str] | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional \`\`\`python ami_type: NodegroupAmiType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional \`\`\`python capacity_type: CapacityType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desired_size\`Optional +##### \`desired_size\`Optional \`\`\`python desired_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -74252,26 +76340,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional \`\`\`python disk_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`force_update\`Optional +##### \`force_update\`Optional \`\`\`python force_update: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -74280,56 +76368,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional \`\`\`python instance_types: typing.List[InstanceType] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] +- *Type:* typing.List[aws_cdk.aws_ec2.InstanceType] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`python labels: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launch_template_spec\`Optional +##### \`launch_template_spec\`Optional \`\`\`python launch_template_spec: LaunchTemplateSpec \`\`\` -- *Type:* [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`max_size\`Optional +##### \`max_size\`Optional \`\`\`python max_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -74338,13 +76426,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`min_size\`Optional +##### \`min_size\`Optional \`\`\`python min_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -74353,26 +76441,26 @@ This number must be greater than zero. --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* resource ID Name of the Nodegroup. --- -##### \`node_role\`Optional +##### \`node_role\`Optional \`\`\`python node_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -74381,26 +76469,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`release_version\`Optional +##### \`release_version\`Optional \`\`\`python release_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional \`\`\`python remote_access: NodegroupRemoteAccess \`\`\` -- *Type:* [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -74409,13 +76497,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`python subnets: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -74424,13 +76512,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -74439,11 +76527,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74469,63 +76557,63 @@ aws_eks.NodegroupProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ami_type\`](#awscdkawseksnodegrouppropspropertyamitype) | [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacity_type\`](#awscdkawseksnodegrouppropspropertycapacitytype) | [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desired_size\`](#awscdkawseksnodegrouppropspropertydesiredsize) | \`typing.Union[int, float]\` | The current number of worker nodes that the managed node group should maintain. | -| [\`disk_size\`](#awscdkawseksnodegrouppropspropertydisksize) | \`typing.Union[int, float]\` | The root device disk size (in GiB) for your node group instances. | -| [\`force_update\`](#awscdkawseksnodegrouppropspropertyforceupdate) | \`bool\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instance_types\`](#awscdkawseksnodegrouppropspropertyinstancetypes) | typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] | The instance types to use for your node group. | -| [\`labels\`](#awscdkawseksnodegrouppropspropertylabels) | typing.Mapping[\`str\`] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launch_template_spec\`](#awscdkawseksnodegrouppropspropertylaunchtemplatespec) | [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`max_size\`](#awscdkawseksnodegrouppropspropertymaxsize) | \`typing.Union[int, float]\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`min_size\`](#awscdkawseksnodegrouppropspropertyminsize) | \`typing.Union[int, float]\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroup_name\`](#awscdkawseksnodegrouppropspropertynodegroupname) | \`str\` | Name of the Nodegroup. | -| [\`node_role\`](#awscdkawseksnodegrouppropspropertynoderole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`release_version\`](#awscdkawseksnodegrouppropspropertyreleaseversion) | \`str\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remote_access\`](#awscdkawseksnodegrouppropspropertyremoteaccess) | [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#awscdkawseksnodegrouppropspropertysubnets) | [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#awscdkawseksnodegrouppropspropertytags) | typing.Mapping[\`str\`] | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#awscdkawseksnodegrouppropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | Cluster resource. | +| ami_type | NodegroupAmiType | The AMI type for your node group. | +| capacity_type | CapacityType | The capacity type of the nodegroup. | +| desired_size | typing.Union[int, float] | The current number of worker nodes that the managed node group should maintain. | +| disk_size | typing.Union[int, float] | The root device disk size (in GiB) for your node group instances. | +| force_update | bool | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instance_types | typing.List[aws_cdk.aws_ec2.InstanceType] | The instance types to use for your node group. | +| labels | typing.Mapping[str] | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launch_template_spec | LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| max_size | typing.Union[int, float] | The maximum number of worker nodes that the managed node group can scale out to. | +| min_size | typing.Union[int, float] | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroup_name | str | Name of the Nodegroup. | +| node_role | aws_cdk.aws_iam.IRole | The IAM role to associate with your node group. | +| release_version | str | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remote_access | NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | aws_cdk.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | typing.Mapping[str] | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | ICluster | Cluster resource. | --- -##### \`ami_type\`Optional +##### \`ami_type\`Optional \`\`\`python ami_type: NodegroupAmiType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.NodegroupAmiType\`](#aws_cdk.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacity_type\`Optional +##### \`capacity_type\`Optional \`\`\`python capacity_type: CapacityType \`\`\` -- *Type:* [\`aws_cdk.aws_eks.CapacityType\`](#aws_cdk.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desired_size\`Optional +##### \`desired_size\`Optional \`\`\`python desired_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -74534,26 +76622,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`disk_size\`Optional +##### \`disk_size\`Optional \`\`\`python disk_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`force_update\`Optional +##### \`force_update\`Optional \`\`\`python force_update: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -74562,56 +76650,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instance_types\`Optional +##### \`instance_types\`Optional \`\`\`python instance_types: typing.List[InstanceType] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.InstanceType\`](#aws_cdk.aws_ec2.InstanceType)] +- *Type:* typing.List[aws_cdk.aws_ec2.InstanceType] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`python labels: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launch_template_spec\`Optional +##### \`launch_template_spec\`Optional \`\`\`python launch_template_spec: LaunchTemplateSpec \`\`\` -- *Type:* [\`aws_cdk.aws_eks.LaunchTemplateSpec\`](#aws_cdk.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`max_size\`Optional +##### \`max_size\`Optional \`\`\`python max_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -74620,13 +76708,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`min_size\`Optional +##### \`min_size\`Optional \`\`\`python min_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -74635,26 +76723,26 @@ This number must be greater than zero. --- -##### \`nodegroup_name\`Optional +##### \`nodegroup_name\`Optional \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* resource ID Name of the Nodegroup. --- -##### \`node_role\`Optional +##### \`node_role\`Optional \`\`\`python node_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -74663,26 +76751,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`release_version\`Optional +##### \`release_version\`Optional \`\`\`python release_version: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remote_access\`Optional +##### \`remote_access\`Optional \`\`\`python remote_access: NodegroupRemoteAccess \`\`\` -- *Type:* [\`aws_cdk.aws_eks.NodegroupRemoteAccess\`](#aws_cdk.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -74691,13 +76779,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`python subnets: SubnetSelection \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.SubnetSelection\`](#aws_cdk.aws_ec2.SubnetSelection) +- *Type:* aws_cdk.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -74706,13 +76794,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`python tags: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -74721,25 +76809,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74750,34 +76838,34 @@ aws_eks.NodegroupRemoteAccess( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ssh_key_name\`](#awscdkawseksnodegroupremoteaccesspropertysshkeyname)* | \`str\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`source_security_groups\`](#awscdkawseksnodegroupremoteaccesspropertysourcesecuritygroups) | typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| ssh_key_name | str | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| source_security_groups | typing.List[aws_cdk.aws_ec2.ISecurityGroup] | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`ssh_key_name\`Required +##### \`ssh_key_name\`Required \`\`\`python ssh_key_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`source_security_groups\`Optional +##### \`source_security_groups\`Optional \`\`\`python source_security_groups: typing.List[ISecurityGroup] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup)] +- *Type:* typing.List[aws_cdk.aws_ec2.ISecurityGroup] - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -74786,11 +76874,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74800,21 +76888,21 @@ aws_eks.OpenIdConnectProviderProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`url\`](#awscdkawseksopenidconnectproviderpropspropertyurl)* | \`str\` | The URL of the identity provider. | +| url | str | The URL of the identity provider. | --- -##### \`url\`Required +##### \`url\`Required \`\`\`python url: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URL of the identity provider. @@ -74822,11 +76910,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74836,21 +76924,21 @@ aws_eks.CfnCluster.ProviderProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`key_arn\`](#awscdkawsekscfnclusterproviderpropertypropertykeyarn) | \`str\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| key_arn | str | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`key_arn\`Optional +##### \`key_arn\`Optional \`\`\`python key_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnCluster.ProviderProperty.KeyArn\`. @@ -74858,11 +76946,11 @@ key_arn: str --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74873,22 +76961,22 @@ aws_eks.CfnNodegroup.RemoteAccessProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ec2_ssh_key\`](#awscdkawsekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`str\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`source_security_groups\`](#awscdkawsekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | typing.List[\`str\`] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| ec2_ssh_key | str | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| source_security_groups | typing.List[str] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`ec2_ssh_key\`Required +##### \`ec2_ssh_key\`Required \`\`\`python ec2_ssh_key: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -74896,13 +76984,13 @@ ec2_ssh_key: str --- -##### \`source_security_groups\`Optional +##### \`source_security_groups\`Optional \`\`\`python source_security_groups: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -74910,11 +76998,11 @@ source_security_groups: typing.List[str] --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74925,22 +77013,22 @@ aws_eks.CfnCluster.ResourcesVpcConfigProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`subnet_ids\`](#awscdkawsekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | typing.List[\`str\`] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`security_group_ids\`](#awscdkawsekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | typing.List[\`str\`] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| subnet_ids | typing.List[str] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| security_group_ids | typing.List[str] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`subnet_ids\`Required +##### \`subnet_ids\`Required \`\`\`python subnet_ids: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -74948,13 +77036,13 @@ subnet_ids: typing.List[str] --- -##### \`security_group_ids\`Optional +##### \`security_group_ids\`Optional \`\`\`python security_group_ids: typing.List[str] \`\`\` -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -74962,11 +77050,11 @@ security_group_ids: typing.List[str] --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -74978,23 +77066,23 @@ aws_eks.CfnNodegroup.ScalingConfigProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`desired_size\`](#awscdkawsekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`typing.Union[int, float]\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`max_size\`](#awscdkawsekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`typing.Union[int, float]\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`min_size\`](#awscdkawsekscfnnodegroupscalingconfigpropertypropertyminsize) | \`typing.Union[int, float]\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| desired_size | typing.Union[int, float] | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| max_size | typing.Union[int, float] | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| min_size | typing.Union[int, float] | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`desired_size\`Optional +##### \`desired_size\`Optional \`\`\`python desired_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -75002,13 +77090,13 @@ desired_size: typing.Union[int, float] --- -##### \`max_size\`Optional +##### \`max_size\`Optional \`\`\`python max_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -75016,13 +77104,13 @@ max_size: typing.Union[int, float] --- -##### \`min_size\`Optional +##### \`min_size\`Optional \`\`\`python min_size: typing.Union[int, float] \`\`\` -- *Type:* \`typing.Union[int, float]\` +- *Type:* typing.Union[int, float] \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -75030,11 +77118,11 @@ min_size: typing.Union[int, float] --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75045,22 +77133,22 @@ aws_eks.Selector( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdkawseksselectorpropertynamespace)* | \`str\` | The Kubernetes namespace that the selector should match. | -| [\`labels\`](#awscdkawseksselectorpropertylabels) | typing.Mapping[\`str\`] | The Kubernetes labels that the selector should match. | +| namespace | str | The Kubernetes namespace that the selector should match. | +| labels | typing.Mapping[str] | The Kubernetes labels that the selector should match. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str The Kubernetes namespace that the selector should match. @@ -75068,13 +77156,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`python labels: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -75083,11 +77171,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75098,22 +77186,22 @@ aws_eks.CfnFargateProfile.SelectorProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdkawsekscfnfargateprofileselectorpropertypropertynamespace)* | \`str\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`labels\`](#awscdkawsekscfnfargateprofileselectorpropertypropertylabels) | typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.LabelProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.LabelProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| namespace | str | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| labels | typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[LabelProperty, aws_cdk.IResolvable]]] | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -75121,13 +77209,13 @@ namespace: str --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`python labels: typing.Union[IResolvable, typing.List[typing.Union[LabelProperty, IResolvable]]] \`\`\` -- *Type:* typing.Union[[\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable), typing.List[typing.Union[[\`aws_cdk.aws_eks.CfnFargateProfile.LabelProperty\`](#aws_cdk.aws_eks.CfnFargateProfile.LabelProperty), [\`aws_cdk.IResolvable\`](#aws_cdk.IResolvable)]]] +- *Type:* typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[LabelProperty, aws_cdk.IResolvable]]] \`CfnFargateProfile.SelectorProperty.Labels\`. @@ -75135,11 +77223,11 @@ labels: typing.Union[IResolvable, typing.List[typing.Union[LabelProperty, IResol --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75150,46 +77238,46 @@ aws_eks.ServiceAccountOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#awscdkawseksserviceaccountoptionspropertyname) | \`str\` | The name of the service account. | -| [\`namespace\`](#awscdkawseksserviceaccountoptionspropertynamespace) | \`str\` | The namespace of the service account. | +| name | str | The name of the service account. | +| namespace | str | The namespace of the service account. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`python name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75201,59 +77289,59 @@ aws_eks.ServiceAccountProps( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#awscdkawseksserviceaccountpropspropertyname) | \`str\` | The name of the service account. | -| [\`namespace\`](#awscdkawseksserviceaccountpropspropertynamespace) | \`str\` | The namespace of the service account. | -| [\`cluster\`](#awscdkawseksserviceaccountpropspropertycluster)* | [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) | The cluster to apply the patch to. | +| name | str | The name of the service account. | +| namespace | str | The namespace of the service account. | +| cluster | ICluster | The cluster to apply the patch to. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`python name: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`python cluster: ICluster \`\`\` -- *Type:* [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75264,46 +77352,46 @@ aws_eks.ServiceLoadBalancerAddressOptions( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdkawseksserviceloadbalanceraddressoptionspropertynamespace) | \`str\` | The namespace the service belongs to. | -| [\`timeout\`](#awscdkawseksserviceloadbalanceraddressoptionspropertytimeout) | [\`aws_cdk.Duration\`](#aws_cdk.Duration) | Timeout for waiting on the load balancer address. | +| namespace | str | The namespace the service belongs to. | +| timeout | aws_cdk.Duration | Timeout for waiting on the load balancer address. | --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`python namespace: str \`\`\` -- *Type:* \`str\` +- *Type:* str - *Default:* 'default' The namespace the service belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`python timeout: Duration \`\`\` -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`python from aws_cdk import aws_eks @@ -75315,23 +77403,23 @@ aws_eks.CfnNodegroup.TaintProperty( ) \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`effect\`](#awscdkawsekscfnnodegrouptaintpropertypropertyeffect) | \`str\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`key\`](#awscdkawsekscfnnodegrouptaintpropertypropertykey) | \`str\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`value\`](#awscdkawsekscfnnodegrouptaintpropertypropertyvalue) | \`str\` | \`CfnNodegroup.TaintProperty.Value\`. | +| effect | str | \`CfnNodegroup.TaintProperty.Effect\`. | +| key | str | \`CfnNodegroup.TaintProperty.Key\`. | +| value | str | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`effect\`Optional +##### \`effect\`Optional \`\`\`python effect: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.TaintProperty.Effect\`. @@ -75339,13 +77427,13 @@ effect: str --- -##### \`key\`Optional +##### \`key\`Optional \`\`\`python key: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.TaintProperty.Key\`. @@ -75353,13 +77441,13 @@ key: str --- -##### \`value\`Optional +##### \`value\`Optional \`\`\`python value: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`CfnNodegroup.TaintProperty.Value\`. @@ -75367,15 +77455,15 @@ value: str --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`aws_cdk.aws_ec2.IMachineImage\`](#aws_cdk.aws_ec2.IMachineImage) +- *Implements:* aws_cdk.aws_ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`python from aws_cdk import aws_eks @@ -75389,48 +77477,48 @@ aws_eks.EksOptimizedImage( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpu_arch\`](#awscdkawsekseksoptimizedimagepropsparametercpuarch) | [\`aws_cdk.aws_eks.CpuArch\`](#aws_cdk.aws_eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetes_version\`](#awscdkawsekseksoptimizedimagepropsparameterkubernetesversion) | \`str\` | The Kubernetes version to use. | -| [\`node_type\`](#awscdkawsekseksoptimizedimagepropsparameternodetype) | [\`aws_cdk.aws_eks.NodeType\`](#aws_cdk.aws_eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpu_arch | CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetes_version | str | The Kubernetes version to use. | +| node_type | NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpu_arch\`Optional +##### \`cpu_arch\`Optional -- *Type:* [\`aws_cdk.aws_eks.CpuArch\`](#aws_cdk.aws_eks.CpuArch) +- *Type:* CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetes_version\`Optional +##### \`kubernetes_version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* The latest version The Kubernetes version to use. --- -##### \`node_type\`Optional +##### \`node_type\`Optional -- *Type:* [\`aws_cdk.aws_eks.NodeType\`](#aws_cdk.aws_eks.NodeType) +- *Type:* NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`get_image\`](#awscdkawsekseksoptimizedimagegetimage) | Return the correct image. | +| get_image | Return the correct image. | --- -##### \`get_image\` +##### \`get_image\` \`\`\`python def get_image( @@ -75438,28 +77526,28 @@ def get_image( ) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`only_from\`](#awscdkawseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| only_from | Restrict public access to specific CIDR blocks. | --- -##### \`only_from\` +##### \`only_from\` \`\`\`python def only_from( @@ -75467,9 +77555,9 @@ def only_from( ) \`\`\` -###### \`cidr\`Required +###### \`cidr\`Required -- *Type:* \`str\` +- *Type:* str CIDR blocks. @@ -75477,19 +77565,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PRIVATE\`](#awscdkawseksendpointaccesspropertyprivate)* | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`PUBLIC\`](#awscdkawseksendpointaccesspropertypublic)* | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PUBLIC_AND_PRIVATE\`](#awscdkawseksendpointaccesspropertypublicandprivate)* | [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| PRIVATE | EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| PUBLIC | EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PUBLIC_AND_PRIVATE | EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`PRIVATE\` +##### \`PRIVATE\`Required + +\`\`\`python +PRIVATE: EndpointAccess +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -75497,9 +77589,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`PUBLIC\` +##### \`PUBLIC\`Required + +\`\`\`python +PUBLIC: EndpointAccess +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +- *Type:* EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -75507,9 +77603,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PUBLIC_AND_PRIVATE\` +##### \`PUBLIC_AND_PRIVATE\`Required -- *Type:* [\`aws_cdk.aws_eks.EndpointAccess\`](#aws_cdk.aws_eks.EndpointAccess) +\`\`\`python +PUBLIC_AND_PRIVATE: EndpointAccess +\`\`\` + +- *Type:* EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -75517,20 +77617,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`of\`](#awscdkawsekskubernetesversionof) | Custom cluster version. | +| of | Custom cluster version. | --- -##### \`of\` +##### \`of\` \`\`\`python from aws_cdk import aws_eks @@ -75540,117 +77640,141 @@ aws_eks.KubernetesVersion.of( ) \`\`\` -###### \`version\`Required +###### \`version\`Required -- *Type:* \`str\` +- *Type:* str custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdkawsekskubernetesversionpropertyversion)* | \`str\` | cluster version number. | +| version | str | cluster version number. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`python version: str \`\`\` -- *Type:* \`str\` +- *Type:* str cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V1_14\`](#awscdkawsekskubernetesversionpropertyv114)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V1_15\`](#awscdkawsekskubernetesversionpropertyv115)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V1_16\`](#awscdkawsekskubernetesversionpropertyv116)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V1_17\`](#awscdkawsekskubernetesversionpropertyv117)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V1_18\`](#awscdkawsekskubernetesversionpropertyv118)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V1_19\`](#awscdkawsekskubernetesversionpropertyv119)* | [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) | Kubernetes version 1.19. | +| V1_14 | KubernetesVersion | Kubernetes version 1.14. | +| V1_15 | KubernetesVersion | Kubernetes version 1.15. | +| V1_16 | KubernetesVersion | Kubernetes version 1.16. | +| V1_17 | KubernetesVersion | Kubernetes version 1.17. | +| V1_18 | KubernetesVersion | Kubernetes version 1.18. | +| V1_19 | KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V1_14\` +##### \`V1_14\`Required -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +\`\`\`python +V1_14: KubernetesVersion +\`\`\` + +- *Type:* KubernetesVersion Kubernetes version 1.14. --- -##### \`V1_15\` +##### \`V1_15\`Required + +\`\`\`python +V1_15: KubernetesVersion +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.15. --- -##### \`V1_16\` +##### \`V1_16\`Required + +\`\`\`python +V1_16: KubernetesVersion +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.16. --- -##### \`V1_17\` +##### \`V1_17\`Required -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +\`\`\`python +V1_17: KubernetesVersion +\`\`\` + +- *Type:* KubernetesVersion Kubernetes version 1.17. --- -##### \`V1_18\` +##### \`V1_18\`Required + +\`\`\`python +V1_18: KubernetesVersion +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.18. --- -##### \`V1_19\` +##### \`V1_19\`Required + +\`\`\`python +V1_19: KubernetesVersion +\`\`\` -- *Type:* [\`aws_cdk.aws_eks.KubernetesVersion\`](#aws_cdk.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`aws_cdk.IResource\`](#aws_cdk.IResource), [\`aws_cdk.aws_ec2.IConnectable\`](#aws_cdk.aws_ec2.IConnectable) +- *Extends:* aws_cdk.IResource, aws_cdk.aws_ec2.IConnectable -- *Implemented By:* [\`aws_cdk.aws_eks.Cluster\`](#aws_cdk.aws_eks.Cluster), [\`aws_cdk.aws_eks.FargateCluster\`](#aws_cdk.aws_eks.FargateCluster), [\`aws_cdk.aws_eks.ICluster\`](#aws_cdk.aws_eks.ICluster) +- *Implemented By:* Cluster, FargateCluster, ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`add_cdk8s_chart\`](#awscdkawseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`add_helm_chart\`](#awscdkawseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`add_manifest\`](#awscdkawseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`add_service_account\`](#awscdkawseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| add_cdk8s_chart | Defines a CDK8s chart in this cluster. | +| add_helm_chart | Defines a Helm chart in this cluster. | +| add_manifest | Defines a Kubernetes resource in this cluster. | +| add_service_account | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`add_cdk8s_chart\` +##### \`add_cdk8s_chart\` \`\`\`python def add_cdk8s_chart( @@ -75659,23 +77783,23 @@ def add_cdk8s_chart( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the cdk8s chart. --- -##### \`add_helm_chart\` +##### \`add_helm_chart\` \`\`\`python def add_helm_chart( @@ -75692,52 +77816,52 @@ def add_helm_chart( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* \`str\` +- *Type:* str The name of the chart. --- -###### \`create_namespace\`Optional +###### \`create_namespace\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* true create namespace if not exist. --- -###### \`namespace\`Optional +###### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* default The Kubernetes namespace scope of the requests. --- -###### \`release\`Optional +###### \`release\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -###### \`repository\`Optional +###### \`repository\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -75746,9 +77870,9 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -###### \`timeout\`Optional +###### \`timeout\`Optional -- *Type:* [\`aws_cdk.Duration\`](#aws_cdk.Duration) +- *Type:* aws_cdk.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -75757,34 +77881,34 @@ Maximum 15 minutes. --- -###### \`values\`Optional +###### \`values\`Optional -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] - *Default:* No values are provided to the chart. The values to be used by the chart. --- -###### \`version\`Optional +###### \`version\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -###### \`wait\`Optional +###### \`wait\`Optional -- *Type:* \`bool\` +- *Type:* bool - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`add_manifest\` +##### \`add_manifest\` \`\`\`python def add_manifest( @@ -75793,23 +77917,23 @@ def add_manifest( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* typing.Mapping[\`typing.Any\`] +- *Type:* typing.Mapping[typing.Any] a list of Kubernetes resource specifications. --- -##### \`add_service_account\` +##### \`add_service_account\` \`\`\`python def add_service_account( @@ -75819,78 +77943,78 @@ def add_service_account( ) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`str\` +- *Type:* str logical id of service account. --- -###### \`name\`Optional +###### \`name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -###### \`namespace\`Optional +###### \`namespace\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* \\"default\\" The namespace of the service account. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawseksiclusterpropertynode)* | [\`constructs.Node\`](#constructs.Node) | The tree node. | -| [\`env\`](#awscdkawseksiclusterpropertyenv)* | [\`aws_cdk.ResourceEnvironment\`](#aws_cdk.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawseksiclusterpropertystack)* | [\`aws_cdk.Stack\`](#aws_cdk.Stack) | The stack in which this resource is defined. | -| [\`connections\`](#awscdkawseksiclusterpropertyconnections)* | [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) | *No description.* | -| [\`cluster_arn\`](#awscdkawseksiclusterpropertyclusterarn)* | \`str\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`cluster_certificate_authority_data\`](#awscdkawseksiclusterpropertyclustercertificateauthoritydata)* | \`str\` | The certificate-authority-data for your cluster. | -| [\`cluster_encryption_config_key_arn\`](#awscdkawseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`str\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`cluster_endpoint\`](#awscdkawseksiclusterpropertyclusterendpoint)* | \`str\` | The API Server endpoint URL. | -| [\`cluster_name\`](#awscdkawseksiclusterpropertyclustername)* | \`str\` | The physical name of the Cluster. | -| [\`cluster_security_group\`](#awscdkawseksiclusterpropertyclustersecuritygroup)* | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`cluster_security_group_id\`](#awscdkawseksiclusterpropertyclustersecuritygroupid)* | \`str\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`open_id_connect_provider\`](#awscdkawseksiclusterpropertyopenidconnectprovider)* | [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`prune\`](#awscdkawseksiclusterpropertyprune)* | \`bool\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`vpc\`](#awscdkawseksiclusterpropertyvpc)* | [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`kubectl_environment\`](#awscdkawseksiclusterpropertykubectlenvironment) | typing.Mapping[\`str\`] | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectl_layer\`](#awscdkawseksiclusterpropertykubectllayer) | [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`kubectl_memory\`](#awscdkawseksiclusterpropertykubectlmemory) | [\`aws_cdk.Size\`](#aws_cdk.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectl_private_subnets\`](#awscdkawseksiclusterpropertykubectlprivatesubnets) | typing.List[[\`aws_cdk.aws_ec2.ISubnet\`](#aws_cdk.aws_ec2.ISubnet)] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectl_role\`](#awscdkawseksiclusterpropertykubectlrole) | [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectl_security_group\`](#awscdkawseksiclusterpropertykubectlsecuritygroup) | [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| node | constructs.Node | The tree node. | +| env | aws_cdk.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws_cdk.Stack | The stack in which this resource is defined. | +| connections | aws_cdk.aws_ec2.Connections | *No description.* | +| cluster_arn | str | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| cluster_certificate_authority_data | str | The certificate-authority-data for your cluster. | +| cluster_encryption_config_key_arn | str | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| cluster_endpoint | str | The API Server endpoint URL. | +| cluster_name | str | The physical name of the Cluster. | +| cluster_security_group | aws_cdk.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| cluster_security_group_id | str | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| open_id_connect_provider | aws_cdk.aws_iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| prune | bool | Indicates whether Kubernetes resources can be automatically pruned. | +| vpc | aws_cdk.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| kubectl_environment | typing.Mapping[str] | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectl_layer | aws_cdk.aws_lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| kubectl_memory | aws_cdk.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectl_private_subnets | typing.List[aws_cdk.aws_ec2.ISubnet] | Subnets to host the \`kubectl\` compute resources. | +| kubectl_role | aws_cdk.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectl_security_group | aws_cdk.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`python node: Node \`\`\` -- *Type:* [\`constructs.Node\`](#constructs.Node) +- *Type:* constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`python env: ResourceEnvironment \`\`\` -- *Type:* [\`aws_cdk.ResourceEnvironment\`](#aws_cdk.ResourceEnvironment) +- *Type:* aws_cdk.ResourceEnvironment The environment this resource belongs to. @@ -75898,131 +78022,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`python stack: Stack \`\`\` -- *Type:* [\`aws_cdk.Stack\`](#aws_cdk.Stack) +- *Type:* aws_cdk.Stack The stack in which this resource is defined. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`python connections: Connections \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.Connections\`](#aws_cdk.aws_ec2.Connections) +- *Type:* aws_cdk.aws_ec2.Connections --- -##### \`cluster_arn\`Required +##### \`cluster_arn\`Required \`\`\`python cluster_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`cluster_certificate_authority_data\`Required +##### \`cluster_certificate_authority_data\`Required \`\`\`python cluster_certificate_authority_data: str \`\`\` -- *Type:* \`str\` +- *Type:* str The certificate-authority-data for your cluster. --- -##### \`cluster_encryption_config_key_arn\`Required +##### \`cluster_encryption_config_key_arn\`Required \`\`\`python cluster_encryption_config_key_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`cluster_endpoint\`Required +##### \`cluster_endpoint\`Required \`\`\`python cluster_endpoint: str \`\`\` -- *Type:* \`str\` +- *Type:* str The API Server endpoint URL. --- -##### \`cluster_name\`Required +##### \`cluster_name\`Required \`\`\`python cluster_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The physical name of the Cluster. --- -##### \`cluster_security_group\`Required +##### \`cluster_security_group\`Required \`\`\`python cluster_security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`cluster_security_group_id\`Required +##### \`cluster_security_group_id\`Required \`\`\`python cluster_security_group_id: str \`\`\` -- *Type:* \`str\` +- *Type:* str The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`open_id_connect_provider\`Required +##### \`open_id_connect_provider\`Required \`\`\`python open_id_connect_provider: IOpenIdConnectProvider \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IOpenIdConnectProvider\`](#aws_cdk.aws_iam.IOpenIdConnectProvider) +- *Type:* aws_cdk.aws_iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`python prune: bool \`\`\` -- *Type:* \`bool\` +- *Type:* bool Indicates whether Kubernetes resources can be automatically pruned. @@ -76030,37 +78154,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`python vpc: IVpc \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.IVpc\`](#aws_cdk.aws_ec2.IVpc) +- *Type:* aws_cdk.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`kubectl_environment\`Optional +##### \`kubectl_environment\`Optional \`\`\`python kubectl_environment: typing.Mapping[str] \`\`\` -- *Type:* typing.Mapping[\`str\`] +- *Type:* typing.Mapping[str] Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectl_layer\`Optional +##### \`kubectl_layer\`Optional \`\`\`python kubectl_layer: ILayerVersion \`\`\` -- *Type:* [\`aws_cdk.aws_lambda.ILayerVersion\`](#aws_cdk.aws_lambda.ILayerVersion) +- *Type:* aws_cdk.aws_lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -76068,25 +78192,25 @@ If not defined, a default layer will be used. --- -##### \`kubectl_memory\`Optional +##### \`kubectl_memory\`Optional \`\`\`python kubectl_memory: Size \`\`\` -- *Type:* [\`aws_cdk.Size\`](#aws_cdk.Size) +- *Type:* aws_cdk.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectl_private_subnets\`Optional +##### \`kubectl_private_subnets\`Optional \`\`\`python kubectl_private_subnets: typing.List[ISubnet] \`\`\` -- *Type:* typing.List[[\`aws_cdk.aws_ec2.ISubnet\`](#aws_cdk.aws_ec2.ISubnet)] +- *Type:* typing.List[aws_cdk.aws_ec2.ISubnet] Subnets to host the \`kubectl\` compute resources. @@ -76094,13 +78218,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectl_role\`Optional +##### \`kubectl_role\`Optional \`\`\`python kubectl_role: IRole \`\`\` -- *Type:* [\`aws_cdk.aws_iam.IRole\`](#aws_cdk.aws_iam.IRole) +- *Type:* aws_cdk.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -76108,13 +78232,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectl_security_group\`Optional +##### \`kubectl_security_group\`Optional \`\`\`python kubectl_security_group: ISecurityGroup \`\`\` -- *Type:* [\`aws_cdk.aws_ec2.ISecurityGroup\`](#aws_cdk.aws_ec2.ISecurityGroup) +- *Type:* aws_cdk.aws_ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -76122,45 +78246,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`aws_cdk.IResource\`](#aws_cdk.IResource) +- *Extends:* aws_cdk.IResource -- *Implemented By:* [\`aws_cdk.aws_eks.Nodegroup\`](#aws_cdk.aws_eks.Nodegroup), [\`aws_cdk.aws_eks.INodegroup\`](#aws_cdk.aws_eks.INodegroup) +- *Implemented By:* Nodegroup, INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawseksinodegrouppropertynode)* | [\`constructs.Node\`](#constructs.Node) | The tree node. | -| [\`env\`](#awscdkawseksinodegrouppropertyenv)* | [\`aws_cdk.ResourceEnvironment\`](#aws_cdk.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawseksinodegrouppropertystack)* | [\`aws_cdk.Stack\`](#aws_cdk.Stack) | The stack in which this resource is defined. | -| [\`nodegroup_name\`](#awscdkawseksinodegrouppropertynodegroupname)* | \`str\` | Name of the nodegroup. | +| node | constructs.Node | The tree node. | +| env | aws_cdk.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws_cdk.Stack | The stack in which this resource is defined. | +| nodegroup_name | str | Name of the nodegroup. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`python node: Node \`\`\` -- *Type:* [\`constructs.Node\`](#constructs.Node) +- *Type:* constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`python env: ResourceEnvironment \`\`\` -- *Type:* [\`aws_cdk.ResourceEnvironment\`](#aws_cdk.ResourceEnvironment) +- *Type:* aws_cdk.ResourceEnvironment The environment this resource belongs to. @@ -76168,164 +78292,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`python stack: Stack \`\`\` -- *Type:* [\`aws_cdk.Stack\`](#aws_cdk.Stack) +- *Type:* aws_cdk.Stack The stack in which this resource is defined. --- -##### \`nodegroup_name\`Required +##### \`nodegroup_name\`Required \`\`\`python nodegroup_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#awscdkawsekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#awscdkawsekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#awscdkawsekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#awscdkawsekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#awscdkawsekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#awscdkawsekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#awscdkawseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#awscdkawseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#awscdkawseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#awscdkawseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#awscdkawseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#awscdkawseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#awscdkawseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -76333,87 +78457,87 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#awscdkawseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#awscdkawseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#awscdkawseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` Inferentia instances. --- -### PatchType +### PatchType | **Name** | **Description** | | --- | --- | -| [\`JSON\`](#awscdkawsekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#awscdkawsekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#awscdkawsekspatchtypestrategic) | Strategic merge patch. | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | --- Values for \`kubectl patch\` --type argument. -#### \`JSON\` +#### \`JSON\` JSON Patch, RFC 6902. --- -#### \`MERGE\` +#### \`MERGE\` JSON Merge patch. --- -#### \`STRATEGIC\` +#### \`STRATEGIC\` Strategic merge patch. @@ -76522,17 +78646,17 @@ repository.addLifecycleRule({ maxImageAge: cdk.Duration.days(30) }); # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnPublicRepository } from '@aws-cdk/aws-ecr' @@ -76542,88 +78666,88 @@ new CfnPublicRepository(scope: Construct, id: string, props?: CfnPublicRepositor | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnpublicrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPublicRepositoryProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdkawsecrcfnpublicrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropertytags)* | [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repositoryCatalogData\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repositoryName\`](#awscdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attrArn | string | *No description.* | +| tags | @aws-cdk/core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryPolicyText | any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) +- *Type:* @aws-cdk/core.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -76631,13 +78755,13 @@ public readonly tags: TagManager; --- -##### \`repositoryCatalogData\`Required +##### \`repositoryCatalogData\`Required \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -76645,13 +78769,13 @@ public readonly repositoryCatalogData: any; --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -76659,13 +78783,13 @@ public readonly repositoryPolicyText: any; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -76673,31 +78797,35 @@ public readonly repositoryName: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnRegistryPolicy } from '@aws-cdk/aws-ecr' @@ -76707,85 +78835,85 @@ new CfnRegistryPolicy(scope: Construct, id: string, props: CfnRegistryPolicyProp | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnregistrypolicyparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnregistrypolicyparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnregistrypolicyparameterprops)* | [\`@aws-cdk/aws-ecr.CfnRegistryPolicyProps\`](#@aws-cdk/aws-ecr.CfnRegistryPolicyProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnRegistryPolicyProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`@aws-cdk/aws-ecr.CfnRegistryPolicyProps\`](#@aws-cdk/aws-ecr.CfnRegistryPolicyProps) +- *Type:* CfnRegistryPolicyProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#awscdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`string\` | *No description.* | -| [\`policyText\`](#awscdkawsecrcfnregistrypolicypropertypolicytext)* | \`any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| attrRegistryId | string | *No description.* | +| policyText | any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`typescript public readonly attrRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`typescript public readonly policyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -76793,31 +78921,35 @@ public readonly policyText: any; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnReplicationConfiguration } from '@aws-cdk/aws-ecr' @@ -76827,85 +78959,85 @@ new CfnReplicationConfiguration(scope: Construct, id: string, props: CfnReplicat | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnreplicationconfigurationparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnreplicationconfigurationparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnreplicationconfigurationparameterprops)* | [\`@aws-cdk/aws-ecr.CfnReplicationConfigurationProps\`](#@aws-cdk/aws-ecr.CfnReplicationConfigurationProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnReplicationConfigurationProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`@aws-cdk/aws-ecr.CfnReplicationConfigurationProps\`](#@aws-cdk/aws-ecr.CfnReplicationConfigurationProps) +- *Type:* CfnReplicationConfigurationProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#awscdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`string\` | *No description.* | -| [\`replicationConfiguration\`](#awscdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attrRegistryId | string | *No description.* | +| replicationConfiguration | @aws-cdk/core.IResolvable \\\\| ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`typescript public readonly attrRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`typescript public readonly replicationConfiguration: IResolvable | ReplicationConfigurationProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* @aws-cdk/core.IResolvable | ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -76913,31 +79045,35 @@ public readonly replicationConfiguration: IResolvable | ReplicationConfiguration --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnRepository } from '@aws-cdk/aws-ecr' @@ -76947,102 +79083,102 @@ new CfnRepository(scope: Construct, id: string, props?: CfnRepositoryProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnrepositoryparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.CfnRepositoryProps\`](#@aws-cdk/aws-ecr.CfnRepositoryProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnRepositoryProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.CfnRepositoryProps\`](#@aws-cdk/aws-ecr.CfnRepositoryProps) +- *Type:* CfnRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdkawsecrcfnrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`attrRepositoryUri\`](#awscdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`string\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnrepositorypropertytags)* | [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryptionConfiguration\`](#awscdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#awscdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`imageTagMutability\`](#awscdkawsecrcfnrepositorypropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#awscdkawsecrcfnrepositorypropertylifecyclepolicy) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#awscdkawsecrcfnrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attrArn | string | *No description.* | +| attrRepositoryUri | string | *No description.* | +| tags | @aws-cdk/core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repositoryPolicyText | any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| imageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | @aws-cdk/core.IResolvable \\\\| LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrRepositoryUri\`Required +##### \`attrRepositoryUri\`Required \`\`\`typescript public readonly attrRepositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) +- *Type:* @aws-cdk/core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -77050,13 +79186,13 @@ public readonly tags: TagManager; --- -##### \`encryptionConfiguration\`Required +##### \`encryptionConfiguration\`Required \`\`\`typescript public readonly encryptionConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -77064,13 +79200,13 @@ public readonly encryptionConfiguration: any; --- -##### \`imageScanningConfiguration\`Required +##### \`imageScanningConfiguration\`Required \`\`\`typescript public readonly imageScanningConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -77078,13 +79214,13 @@ public readonly imageScanningConfiguration: any; --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -77092,13 +79228,13 @@ public readonly repositoryPolicyText: any; --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -77106,13 +79242,13 @@ public readonly imageTagMutability: string; --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`typescript public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* @aws-cdk/core.IResolvable | LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -77120,13 +79256,13 @@ public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -77134,27 +79270,31 @@ public readonly repositoryName: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -77164,75 +79304,75 @@ new Repository(scope: Construct, id: string, props?: RepositoryProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositoryparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositoryparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdkawsecrrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.RepositoryProps\`](#@aws-cdk/aws-ecr.RepositoryProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | RepositoryProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.RepositoryProps\`](#@aws-cdk/aws-ecr.RepositoryProps) +- *Type:* RepositoryProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addLifecycleRule\`](#awscdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`addToResourcePolicy\`](#awscdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| addLifecycleRule | Add a life cycle rule to the repository. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`addLifecycleRule\` +##### \`addLifecycleRule\` \`\`\`typescript public addLifecycleRule(rule: LifecycleRule) \`\`\` -###### \`rule\`Required +###### \`rule\`Required -- *Type:* [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule) +- *Type:* LifecycleRule --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arnForLocalRepository\`](#awscdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`fromRepositoryArn\`](#awscdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`fromRepositoryAttributes\`](#awscdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`fromRepositoryName\`](#awscdkawsecrrepositoryfromrepositoryname) | *No description.* | +| arnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| fromRepositoryArn | *No description.* | +| fromRepositoryAttributes | Import a repository. | +| fromRepositoryName | *No description.* | --- -##### \`arnForLocalRepository\` +##### \`arnForLocalRepository\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -77240,25 +79380,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.arnForLocalRepository(repositoryName: string, scope: IConstruct, account?: string) \`\`\` -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.IConstruct\`](#constructs.IConstruct) +- *Type:* constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`string\` +- *Type:* string --- -##### \`fromRepositoryArn\` +##### \`fromRepositoryArn\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -77266,25 +79406,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryArn(scope: Construct, id: string, repositoryArn: string) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`repositoryArn\`Required +###### \`repositoryArn\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`fromRepositoryAttributes\` +##### \`fromRepositoryAttributes\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -77292,25 +79432,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`@aws-cdk/aws-ecr.RepositoryAttributes\`](#@aws-cdk/aws-ecr.RepositoryAttributes) +- *Type:* RepositoryAttributes --- -##### \`fromRepositoryName\` +##### \`fromRepositoryName\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -77318,67 +79458,67 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryName(scope: Construct, id: string, repositoryName: string) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrrepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`@aws-cdk/aws-ecr.IRepository\`](#@aws-cdk/aws-ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`typescript import { RepositoryBase } from '@aws-cdk/aws-ecr' @@ -77388,255 +79528,255 @@ new RepositoryBase(scope: Construct, id: string, props?: ResourceProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositorybaseparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositorybaseparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdkawsecrrepositorybaseparameterprops) | [\`@aws-cdk/core.ResourceProps\`](#@aws-cdk/core.ResourceProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | @aws-cdk/core.ResourceProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/core.ResourceProps\`](#@aws-cdk/core.ResourceProps) +- *Type:* @aws-cdk/core.ResourceProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#awscdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#awscdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grantPullPush\`](#awscdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#awscdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#awscdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#awscdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#awscdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repositoryUriForDigest\`](#awscdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#awscdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to use the images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`typescript public grant(grantee: IGrantable, actions: string) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`typescript public grantPull(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`typescript public grantPullPush(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions\`](#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`typescript public onEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnImageScanCompletedOptions\`](#@aws-cdk/aws-ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`typescript public repositoryUriForDigest(digest?: string) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`string\` +- *Type:* string Optional image digest. --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`typescript public repositoryUriForTag(tag?: string) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`string\` +- *Type:* string Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositorybasepropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrrepositorybasepropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`repositoryUri\`](#awscdkawsecrrepositorybasepropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | +| repositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`typescript public readonly repositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -77645,15 +79785,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' @@ -77661,24 +79801,24 @@ import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' const cfnPublicRepositoryProps: CfnPublicRepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryCatalogData\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | @aws-cdk/core.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repositoryCatalogData\`Optional +##### \`repositoryCatalogData\`Optional \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -77686,13 +79826,13 @@ public readonly repositoryCatalogData: any; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -77700,13 +79840,13 @@ public readonly repositoryName: string; --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -77714,13 +79854,13 @@ public readonly repositoryPolicyText: any; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] +- *Type:* @aws-cdk/core.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. @@ -77728,13 +79868,13 @@ public readonly tags: CfnTag[]; --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnRegistryPolicyProps } from '@aws-cdk/aws-ecr' @@ -77742,21 +79882,21 @@ import { CfnRegistryPolicyProps } from '@aws-cdk/aws-ecr' const cfnRegistryPolicyProps: CfnRegistryPolicyProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policyText\`](#awscdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policyText | any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`typescript public readonly policyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -77764,13 +79904,13 @@ public readonly policyText: any; --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnReplicationConfigurationProps } from '@aws-cdk/aws-ecr' @@ -77778,21 +79918,21 @@ import { CfnReplicationConfigurationProps } from '@aws-cdk/aws-ecr' const cfnReplicationConfigurationProps: CfnReplicationConfigurationProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replicationConfiguration\`](#awscdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replicationConfiguration | @aws-cdk/core.IResolvable \\\\| ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`typescript public readonly replicationConfiguration: IResolvable | ReplicationConfigurationProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* @aws-cdk/core.IResolvable | ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -77800,13 +79940,13 @@ public readonly replicationConfiguration: IResolvable | ReplicationConfiguration --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnRepositoryProps } from '@aws-cdk/aws-ecr' @@ -77814,27 +79954,27 @@ import { CfnRepositoryProps } from '@aws-cdk/aws-ecr' const cfnRepositoryProps: CfnRepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryptionConfiguration\`](#awscdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#awscdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#awscdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#awscdkawsecrcfnrepositorypropspropertylifecyclepolicy) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#awscdkawsecrcfnrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropspropertytags) | [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | @aws-cdk/core.IResolvable \\\\| LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | @aws-cdk/core.CfnTag[] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryptionConfiguration\`Optional +##### \`encryptionConfiguration\`Optional \`\`\`typescript public readonly encryptionConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -77842,13 +79982,13 @@ public readonly encryptionConfiguration: any; --- -##### \`imageScanningConfiguration\`Optional +##### \`imageScanningConfiguration\`Optional \`\`\`typescript public readonly imageScanningConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -77856,13 +79996,13 @@ public readonly imageScanningConfiguration: any; --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -77870,13 +80010,13 @@ public readonly imageTagMutability: string; --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`typescript public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* @aws-cdk/core.IResolvable | LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -77884,13 +80024,13 @@ public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -77898,13 +80038,13 @@ public readonly repositoryName: string; --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -77912,13 +80052,13 @@ public readonly repositoryPolicyText: any; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] +- *Type:* @aws-cdk/core.CfnTag[] \`AWS::ECR::Repository.Tags\`. @@ -77926,11 +80066,11 @@ public readonly tags: CfnTag[]; --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`typescript import { LifecyclePolicyProperty } from '@aws-cdk/aws-ecr' @@ -77938,22 +80078,22 @@ import { LifecyclePolicyProperty } from '@aws-cdk/aws-ecr' const lifecyclePolicyProperty: LifecyclePolicyProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecyclePolicyText\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registryId\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecyclePolicyText | string | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registryId | string | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecyclePolicyText\`Optional +##### \`lifecyclePolicyText\`Optional \`\`\`typescript public readonly lifecyclePolicyText: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -77961,13 +80101,13 @@ public readonly lifecyclePolicyText: string; --- -##### \`registryId\`Optional +##### \`registryId\`Optional \`\`\`typescript public readonly registryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -77975,11 +80115,11 @@ public readonly registryId: string; --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`typescript import { LifecycleRule } from '@aws-cdk/aws-ecr' @@ -77987,39 +80127,39 @@ import { LifecycleRule } from '@aws-cdk/aws-ecr' const lifecycleRule: LifecycleRule = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecrlifecyclerulepropertydescription) | \`string\` | Describes the purpose of the rule. | -| [\`maxImageAge\`](#awscdkawsecrlifecyclerulepropertymaximageage) | [\`@aws-cdk/core.Duration\`](#@aws-cdk/core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`maxImageCount\`](#awscdkawsecrlifecyclerulepropertymaximagecount) | \`number\` | The maximum number of images to retain. | -| [\`rulePriority\`](#awscdkawsecrlifecyclerulepropertyrulepriority) | \`number\` | Controls the order in which rules are evaluated (low to high). | -| [\`tagPrefixList\`](#awscdkawsecrlifecyclerulepropertytagprefixlist) | \`string\`[] | Select images that have ALL the given prefixes in their tag. | -| [\`tagStatus\`](#awscdkawsecrlifecyclerulepropertytagstatus) | [\`@aws-cdk/aws-ecr.TagStatus\`](#@aws-cdk/aws-ecr.TagStatus) | Select images based on tags. | +| description | string | Describes the purpose of the rule. | +| maxImageAge | @aws-cdk/core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| maxImageCount | number | The maximum number of images to retain. | +| rulePriority | number | Controls the order in which rules are evaluated (low to high). | +| tagPrefixList | string[] | Select images that have ALL the given prefixes in their tag. | +| tagStatus | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description Describes the purpose of the rule. --- -##### \`maxImageAge\`Optional +##### \`maxImageAge\`Optional \`\`\`typescript public readonly maxImageAge: Duration; \`\`\` -- *Type:* [\`@aws-cdk/core.Duration\`](#@aws-cdk/core.Duration) +- *Type:* @aws-cdk/core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -78027,13 +80167,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`maxImageCount\`Optional +##### \`maxImageCount\`Optional \`\`\`typescript public readonly maxImageCount: number; \`\`\` -- *Type:* \`number\` +- *Type:* number The maximum number of images to retain. @@ -78041,13 +80181,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rulePriority\`Optional +##### \`rulePriority\`Optional \`\`\`typescript public readonly rulePriority: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -78056,13 +80196,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tagPrefixList\`Optional +##### \`tagPrefixList\`Optional \`\`\`typescript public readonly tagPrefixList: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] Select images that have ALL the given prefixes in their tag. @@ -78070,13 +80210,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tagStatus\`Optional +##### \`tagStatus\`Optional \`\`\`typescript public readonly tagStatus: TagStatus; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.TagStatus\`](#@aws-cdk/aws-ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -78085,11 +80225,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`typescript import { OnCloudTrailImagePushedOptions } from '@aws-cdk/aws-ecr' @@ -78097,92 +80237,92 @@ import { OnCloudTrailImagePushedOptions } from '@aws-cdk/aws-ecr' const onCloudTrailImagePushedOptions: OnCloudTrailImagePushedOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`eventPattern\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`target\`](#awscdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) | The target to register for the event. | -| [\`imageTag\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`string\` | Only watch changes to this image tag. | +| description | string | A description of the rule's purpose. | +| eventPattern | @aws-cdk/aws-events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | string | A name for the rule. | +| target | @aws-cdk/aws-events.IRuleTarget | The target to register for the event. | +| imageTag | string | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`typescript public readonly eventPattern: EventPattern; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) +- *Type:* @aws-cdk/aws-events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`typescript public readonly ruleName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`typescript public readonly target: IRuleTarget; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) +- *Type:* @aws-cdk/aws-events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTag\`Optional +##### \`imageTag\`Optional \`\`\`typescript public readonly imageTag: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`typescript import { OnImageScanCompletedOptions } from '@aws-cdk/aws-ecr' @@ -78190,81 +80330,81 @@ import { OnImageScanCompletedOptions } from '@aws-cdk/aws-ecr' const onImageScanCompletedOptions: OnImageScanCompletedOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecronimagescancompletedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`eventPattern\`](#awscdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#awscdkawsecronimagescancompletedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`target\`](#awscdkawsecronimagescancompletedoptionspropertytarget) | [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) | The target to register for the event. | -| [\`imageTags\`](#awscdkawsecronimagescancompletedoptionspropertyimagetags) | \`string\`[] | Only watch changes to the image tags spedified. | +| description | string | A description of the rule's purpose. | +| eventPattern | @aws-cdk/aws-events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | string | A name for the rule. | +| target | @aws-cdk/aws-events.IRuleTarget | The target to register for the event. | +| imageTags | string[] | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`typescript public readonly eventPattern: EventPattern; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) +- *Type:* @aws-cdk/aws-events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`typescript public readonly ruleName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`typescript public readonly target: IRuleTarget; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) +- *Type:* @aws-cdk/aws-events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTags\`Optional +##### \`imageTags\`Optional \`\`\`typescript public readonly imageTags: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -78273,11 +80413,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationConfigurationProperty } from '@aws-cdk/aws-ecr' @@ -78285,21 +80425,21 @@ import { ReplicationConfigurationProperty } from '@aws-cdk/aws-ecr' const replicationConfigurationProperty: ReplicationConfigurationProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#awscdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty)[] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | @aws-cdk/core.IResolvable \\\\| @aws-cdk/core.IResolvable \\\\| ReplicationRuleProperty[] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required \`\`\`typescript public readonly rules: IResolvable | IResolvable | ReplicationRuleProperty[]; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty)[] +- *Type:* @aws-cdk/core.IResolvable | @aws-cdk/core.IResolvable | ReplicationRuleProperty[] \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -78307,11 +80447,11 @@ public readonly rules: IResolvable | IResolvable | ReplicationRuleProperty[]; --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationDestinationProperty } from '@aws-cdk/aws-ecr' @@ -78319,22 +80459,22 @@ import { ReplicationDestinationProperty } from '@aws-cdk/aws-ecr' const replicationDestinationProperty: ReplicationDestinationProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registryId\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registryId | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required \`\`\`typescript public readonly region: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -78342,13 +80482,13 @@ public readonly region: string; --- -##### \`registryId\`Required +##### \`registryId\`Required \`\`\`typescript public readonly registryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -78356,11 +80496,11 @@ public readonly registryId: string; --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationRuleProperty } from '@aws-cdk/aws-ecr' @@ -78368,21 +80508,21 @@ import { ReplicationRuleProperty } from '@aws-cdk/aws-ecr' const replicationRuleProperty: ReplicationRuleProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#awscdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)[] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | @aws-cdk/core.IResolvable \\\\| @aws-cdk/core.IResolvable \\\\| ReplicationDestinationProperty[] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required \`\`\`typescript public readonly destinations: IResolvable | IResolvable | ReplicationDestinationProperty[]; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)[] +- *Type:* @aws-cdk/core.IResolvable | @aws-cdk/core.IResolvable | ReplicationDestinationProperty[] \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -78390,9 +80530,9 @@ public readonly destinations: IResolvable | IResolvable | ReplicationDestination --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`typescript import { RepositoryAttributes } from '@aws-cdk/aws-ecr' @@ -78400,38 +80540,38 @@ import { RepositoryAttributes } from '@aws-cdk/aws-ecr' const repositoryAttributes: RepositoryAttributes = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositoryattributespropertyrepositoryarn)* | \`string\` | *No description.* | -| [\`repositoryName\`](#awscdkawsecrrepositoryattributespropertyrepositoryname)* | \`string\` | *No description.* | +| repositoryArn | string | *No description.* | +| repositoryName | string | *No description.* | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`typescript import { RepositoryProps } from '@aws-cdk/aws-ecr' @@ -78439,39 +80579,39 @@ import { RepositoryProps } from '@aws-cdk/aws-ecr' const repositoryProps: RepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`imageScanOnPush\`](#awscdkawsecrrepositorypropspropertyimagescanonpush) | \`boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#awscdkawsecrrepositorypropspropertyimagetagmutability) | [\`@aws-cdk/aws-ecr.TagMutability\`](#@aws-cdk/aws-ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#awscdkawsecrrepositorypropspropertylifecycleregistryid) | \`string\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#awscdkawsecrrepositorypropspropertylifecyclerules) | [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule)[] | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#awscdkawsecrrepositorypropspropertyremovalpolicy) | [\`@aws-cdk/core.RemovalPolicy\`](#@aws-cdk/core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#awscdkawsecrrepositorypropspropertyrepositoryname) | \`string\` | Name for this repository. | +| imageScanOnPush | boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | string | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | LifecycleRule[] | Life cycle rules to apply to this registry. | +| removalPolicy | @aws-cdk/core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | string | Name for this repository. | --- -##### \`imageScanOnPush\`Optional +##### \`imageScanOnPush\`Optional \`\`\`typescript public readonly imageScanOnPush: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: TagMutability; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.TagMutability\`](#@aws-cdk/aws-ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -78480,78 +80620,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycleRegistryId\`Optional +##### \`lifecycleRegistryId\`Optional \`\`\`typescript public readonly lifecycleRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycleRules\`Optional +##### \`lifecycleRules\`Optional \`\`\`typescript public readonly lifecycleRules: LifecycleRule[]; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule)[] +- *Type:* LifecycleRule[] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removalPolicy\`Optional +##### \`removalPolicy\`Optional \`\`\`typescript public readonly removalPolicy: RemovalPolicy; \`\`\` -- *Type:* [\`@aws-cdk/core.RemovalPolicy\`](#@aws-cdk/core.RemovalPolicy) +- *Type:* @aws-cdk/core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`typescript import { AuthorizationToken } from '@aws-cdk/aws-ecr' @@ -78559,30 +80699,30 @@ import { AuthorizationToken } from '@aws-cdk/aws-ecr' AuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#awscdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`typescript import { PublicGalleryAuthorizationToken } from '@aws-cdk/aws-ecr' @@ -78590,239 +80730,239 @@ import { PublicGalleryAuthorizationToken } from '@aws-cdk/aws-ecr' PublicGalleryAuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`@aws-cdk/core.IResource\`](#@aws-cdk/core.IResource) +- *Extends:* @aws-cdk/core.IResource -- *Implemented By:* [\`@aws-cdk/aws-ecr.Repository\`](#@aws-cdk/aws-ecr.Repository), [\`@aws-cdk/aws-ecr.RepositoryBase\`](#@aws-cdk/aws-ecr.RepositoryBase), [\`@aws-cdk/aws-ecr.IRepository\`](#@aws-cdk/aws-ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`typescript public grant(grantee: IGrantable, actions: string) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`typescript public grantPull(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`typescript public grantPullPush(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions\`](#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`typescript public onEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnImageScanCompletedOptions\`](#@aws-cdk/aws-ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`typescript public repositoryUriForDigest(digest?: string) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`typescript public repositoryUriForTag(tag?: string) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`repositoryUri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| node | @aws-cdk/core.ConstructNode | The construct tree node for this construct. | +| env | @aws-cdk/core.ResourceEnvironment | The environment this resource belongs to. | +| stack | @aws-cdk/core.Stack | The stack in which this resource is defined. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | +| repositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`typescript public readonly node: ConstructNode; \`\`\` -- *Type:* [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) +- *Type:* @aws-cdk/core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` -- *Type:* [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) +- *Type:* @aws-cdk/core.ResourceEnvironment The environment this resource belongs to. @@ -78830,49 +80970,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`typescript public readonly stack: Stack; \`\`\` -- *Type:* [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) +- *Type:* @aws-cdk/core.Stack The stack in which this resource is defined. --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`typescript public readonly repositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -78880,60 +81020,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#awscdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#awscdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#awscdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -79042,17 +81182,17 @@ repository.addLifecycleRule({ maxImageAge: cdk.Duration.days(30) }); # API Reference -## Constructs +## Constructs -### CfnPublicRepository +### CfnPublicRepository -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnPublicRepository } from '@aws-cdk/aws-ecr' @@ -79062,88 +81202,88 @@ new CfnPublicRepository(scope: Construct, id: string, props?: CfnPublicRepositor | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnpublicrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPublicRepositoryProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnpublicrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdkawsecrcfnpublicrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropertytags)* | [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) | \`AWS::ECR::PublicRepository.Tags\`. | -| [\`repositoryCatalogData\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorycatalogdata)* | \`any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnpublicrepositorypropertyrepositorypolicytext)* | \`any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`repositoryName\`](#awscdkawsecrcfnpublicrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| attrArn | string | *No description.* | +| tags | @aws-cdk/core.TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryPolicyText | any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) +- *Type:* @aws-cdk/core.TagManager \`AWS::ECR::PublicRepository.Tags\`. @@ -79151,13 +81291,13 @@ public readonly tags: TagManager; --- -##### \`repositoryCatalogData\`Required +##### \`repositoryCatalogData\`Required \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -79165,13 +81305,13 @@ public readonly repositoryCatalogData: any; --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -79179,13 +81319,13 @@ public readonly repositoryPolicyText: any; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -79193,31 +81333,35 @@ public readonly repositoryName: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnpublicrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRegistryPolicy +### CfnRegistryPolicy -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnRegistryPolicy } from '@aws-cdk/aws-ecr' @@ -79227,85 +81371,85 @@ new CfnRegistryPolicy(scope: Construct, id: string, props: CfnRegistryPolicyProp | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnregistrypolicyparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnregistrypolicyparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnregistrypolicyparameterprops)* | [\`@aws-cdk/aws-ecr.CfnRegistryPolicyProps\`](#@aws-cdk/aws-ecr.CfnRegistryPolicyProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnRegistryPolicyProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`@aws-cdk/aws-ecr.CfnRegistryPolicyProps\`](#@aws-cdk/aws-ecr.CfnRegistryPolicyProps) +- *Type:* CfnRegistryPolicyProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnregistrypolicyinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#awscdkawsecrcfnregistrypolicypropertyattrregistryid)* | \`string\` | *No description.* | -| [\`policyText\`](#awscdkawsecrcfnregistrypolicypropertypolicytext)* | \`any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| attrRegistryId | string | *No description.* | +| policyText | any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`typescript public readonly attrRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`typescript public readonly policyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -79313,31 +81457,35 @@ public readonly policyText: any; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnregistrypolicypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnReplicationConfiguration +### CfnReplicationConfiguration -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnReplicationConfiguration } from '@aws-cdk/aws-ecr' @@ -79347,85 +81495,85 @@ new CfnReplicationConfiguration(scope: Construct, id: string, props: CfnReplicat | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnreplicationconfigurationparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnreplicationconfigurationparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnreplicationconfigurationparameterprops)* | [\`@aws-cdk/aws-ecr.CfnReplicationConfigurationProps\`](#@aws-cdk/aws-ecr.CfnReplicationConfigurationProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnReplicationConfigurationProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`@aws-cdk/aws-ecr.CfnReplicationConfigurationProps\`](#@aws-cdk/aws-ecr.CfnReplicationConfigurationProps) +- *Type:* CfnReplicationConfigurationProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnreplicationconfigurationinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrRegistryId\`](#awscdkawsecrcfnreplicationconfigurationpropertyattrregistryid)* | \`string\` | *No description.* | -| [\`replicationConfiguration\`](#awscdkawsecrcfnreplicationconfigurationpropertyreplicationconfiguration)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| attrRegistryId | string | *No description.* | +| replicationConfiguration | @aws-cdk/core.IResolvable \\\\| ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`attrRegistryId\`Required +##### \`attrRegistryId\`Required \`\`\`typescript public readonly attrRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`typescript public readonly replicationConfiguration: IResolvable | ReplicationConfigurationProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* @aws-cdk/core.IResolvable | ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -79433,31 +81581,35 @@ public readonly replicationConfiguration: IResolvable | ReplicationConfiguration --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnreplicationconfigurationpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnRepository +### CfnRepository -- *Implements:* [\`@aws-cdk/core.IInspectable\`](#@aws-cdk/core.IInspectable) +- *Implements:* @aws-cdk/core.IInspectable A CloudFormation \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializers +#### Initializers \`\`\`typescript import { CfnRepository } from '@aws-cdk/aws-ecr' @@ -79467,102 +81619,102 @@ new CfnRepository(scope: Construct, id: string, props?: CfnRepositoryProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnrepositoryparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.CfnRepositoryProps\`](#@aws-cdk/aws-ecr.CfnRepositoryProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnRepositoryProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.CfnRepositoryProps\`](#@aws-cdk/aws-ecr.CfnRepositoryProps) +- *Type:* CfnRepositoryProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdkawsecrcfnrepositoryinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdkawsecrcfnrepositorypropertyattrarn)* | \`string\` | *No description.* | -| [\`attrRepositoryUri\`](#awscdkawsecrcfnrepositorypropertyattrrepositoryuri)* | \`string\` | *No description.* | -| [\`tags\`](#awscdkawsecrcfnrepositorypropertytags)* | [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) | \`AWS::ECR::Repository.Tags\`. | -| [\`encryptionConfiguration\`](#awscdkawsecrcfnrepositorypropertyencryptionconfiguration)* | \`any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#awscdkawsecrcfnrepositorypropertyimagescanningconfiguration)* | \`any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnrepositorypropertyrepositorypolicytext)* | \`any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`imageTagMutability\`](#awscdkawsecrcfnrepositorypropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#awscdkawsecrcfnrepositorypropertylifecyclepolicy) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#awscdkawsecrcfnrepositorypropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | +| attrArn | string | *No description.* | +| attrRepositoryUri | string | *No description.* | +| tags | @aws-cdk/core.TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repositoryPolicyText | any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| imageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | @aws-cdk/core.IResolvable \\\\| LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrRepositoryUri\`Required +##### \`attrRepositoryUri\`Required \`\`\`typescript public readonly attrRepositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`@aws-cdk/core.TagManager\`](#@aws-cdk/core.TagManager) +- *Type:* @aws-cdk/core.TagManager \`AWS::ECR::Repository.Tags\`. @@ -79570,13 +81722,13 @@ public readonly tags: TagManager; --- -##### \`encryptionConfiguration\`Required +##### \`encryptionConfiguration\`Required \`\`\`typescript public readonly encryptionConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -79584,13 +81736,13 @@ public readonly encryptionConfiguration: any; --- -##### \`imageScanningConfiguration\`Required +##### \`imageScanningConfiguration\`Required \`\`\`typescript public readonly imageScanningConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -79598,13 +81750,13 @@ public readonly imageScanningConfiguration: any; --- -##### \`repositoryPolicyText\`Required +##### \`repositoryPolicyText\`Required \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -79612,13 +81764,13 @@ public readonly repositoryPolicyText: any; --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -79626,13 +81778,13 @@ public readonly imageTagMutability: string; --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`typescript public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* @aws-cdk/core.IResolvable | LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -79640,13 +81792,13 @@ public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -79654,27 +81806,31 @@ public readonly repositoryName: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdkawsecrcfnrepositorypropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Repository +### Repository Define an ECR repository. -#### Initializers +#### Initializers \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -79684,75 +81840,75 @@ new Repository(scope: Construct, id: string, props?: RepositoryProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositoryparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositoryparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdkawsecrrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.RepositoryProps\`](#@aws-cdk/aws-ecr.RepositoryProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | RepositoryProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.RepositoryProps\`](#@aws-cdk/aws-ecr.RepositoryProps) +- *Type:* RepositoryProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addLifecycleRule\`](#awscdkawsecrrepositoryaddlifecyclerule) | Add a life cycle rule to the repository. | -| [\`addToResourcePolicy\`](#awscdkawsecrrepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | +| addLifecycleRule | Add a life cycle rule to the repository. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | --- -##### \`addLifecycleRule\` +##### \`addLifecycleRule\` \`\`\`typescript public addLifecycleRule(rule: LifecycleRule) \`\`\` -###### \`rule\`Required +###### \`rule\`Required -- *Type:* [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule) +- *Type:* LifecycleRule --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`arnForLocalRepository\`](#awscdkawsecrrepositoryarnforlocalrepository) | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | -| [\`fromRepositoryArn\`](#awscdkawsecrrepositoryfromrepositoryarn) | *No description.* | -| [\`fromRepositoryAttributes\`](#awscdkawsecrrepositoryfromrepositoryattributes) | Import a repository. | -| [\`fromRepositoryName\`](#awscdkawsecrrepositoryfromrepositoryname) | *No description.* | +| arnForLocalRepository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| fromRepositoryArn | *No description.* | +| fromRepositoryAttributes | Import a repository. | +| fromRepositoryName | *No description.* | --- -##### \`arnForLocalRepository\` +##### \`arnForLocalRepository\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -79760,25 +81916,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.arnForLocalRepository(repositoryName: string, scope: IConstruct, account?: string) \`\`\` -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.IConstruct\`](#constructs.IConstruct) +- *Type:* constructs.IConstruct --- -###### \`account\`Optional +###### \`account\`Optional -- *Type:* \`string\` +- *Type:* string --- -##### \`fromRepositoryArn\` +##### \`fromRepositoryArn\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -79786,25 +81942,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryArn(scope: Construct, id: string, repositoryArn: string) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`repositoryArn\`Required +###### \`repositoryArn\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`fromRepositoryAttributes\` +##### \`fromRepositoryAttributes\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -79812,25 +81968,25 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`@aws-cdk/aws-ecr.RepositoryAttributes\`](#@aws-cdk/aws-ecr.RepositoryAttributes) +- *Type:* RepositoryAttributes --- -##### \`fromRepositoryName\` +##### \`fromRepositoryName\` \`\`\`typescript import { Repository } from '@aws-cdk/aws-ecr' @@ -79838,67 +81994,67 @@ import { Repository } from '@aws-cdk/aws-ecr' Repository.fromRepositoryName(scope: Construct, id: string, repositoryName: string) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`repositoryName\`Required +###### \`repositoryName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrrepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -### RepositoryBase +### RepositoryBase -- *Implements:* [\`@aws-cdk/aws-ecr.IRepository\`](#@aws-cdk/aws-ecr.IRepository) +- *Implements:* IRepository Base class for ECR repository. Reused between imported repositories and owned repositories. -#### Initializers +#### Initializers \`\`\`typescript import { RepositoryBase } from '@aws-cdk/aws-ecr' @@ -79908,255 +82064,255 @@ new RepositoryBase(scope: Construct, id: string, props?: ResourceProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrrepositorybaseparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdkawsecrrepositorybaseparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdkawsecrrepositorybaseparameterprops) | [\`@aws-cdk/core.ResourceProps\`](#@aws-cdk/core.ResourceProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | @aws-cdk/core.ResourceProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`@aws-cdk/core.ResourceProps\`](#@aws-cdk/core.ResourceProps) +- *Type:* @aws-cdk/core.ResourceProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#awscdkawsecrrepositorybaseaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrrepositorybasegrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#awscdkawsecrrepositorybasegrantpull) | Grant the given identity permissions to use the images in this repository. | -| [\`grantPullPush\`](#awscdkawsecrrepositorybasegrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#awscdkawsecrrepositorybaseoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#awscdkawsecrrepositorybaseoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#awscdkawsecrrepositorybaseonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#awscdkawsecrrepositorybaseonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | -| [\`repositoryUriForDigest\`](#awscdkawsecrrepositorybaserepositoryurifordigest) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#awscdkawsecrrepositorybaserepositoryurifortag) | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to use the images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repositoryUriForDigest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`typescript public grant(grantee: IGrantable, actions: string) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`typescript public grantPull(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`typescript public grantPullPush(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions\`](#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`typescript public onEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnImageScanCompletedOptions\`](#@aws-cdk/aws-ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`typescript public repositoryUriForDigest(digest?: string) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`string\` +- *Type:* string Optional image digest. --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`typescript public repositoryUriForTag(tag?: string) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`string\` +- *Type:* string Optional image tag. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositorybasepropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrrepositorybasepropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`repositoryUri\`](#awscdkawsecrrepositorybasepropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | +| repositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`typescript public readonly repositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -80165,15 +82321,15 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Structs +## Structs -### CfnPublicRepositoryProps +### CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' @@ -80181,24 +82337,24 @@ import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' const cfnPublicRepositoryProps: CfnPublicRepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryCatalogData\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | @aws-cdk/core.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -##### \`repositoryCatalogData\`Optional +##### \`repositoryCatalogData\`Optional \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -80206,13 +82362,13 @@ public readonly repositoryCatalogData: any; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -80220,13 +82376,13 @@ public readonly repositoryName: string; --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -80234,13 +82390,13 @@ public readonly repositoryPolicyText: any; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] +- *Type:* @aws-cdk/core.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. @@ -80248,13 +82404,13 @@ public readonly tags: CfnTag[]; --- -### CfnRegistryPolicyProps +### CfnRegistryPolicyProps Properties for defining a \`AWS::ECR::RegistryPolicy\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnRegistryPolicyProps } from '@aws-cdk/aws-ecr' @@ -80262,21 +82418,21 @@ import { CfnRegistryPolicyProps } from '@aws-cdk/aws-ecr' const cfnRegistryPolicyProps: CfnRegistryPolicyProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`policyText\`](#awscdkawsecrcfnregistrypolicypropspropertypolicytext)* | \`any\` | \`AWS::ECR::RegistryPolicy.PolicyText\`. | +| policyText | any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | --- -##### \`policyText\`Required +##### \`policyText\`Required \`\`\`typescript public readonly policyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::RegistryPolicy.PolicyText\`. @@ -80284,13 +82440,13 @@ public readonly policyText: any; --- -### CfnReplicationConfigurationProps +### CfnReplicationConfigurationProps Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnReplicationConfigurationProps } from '@aws-cdk/aws-ecr' @@ -80298,21 +82454,21 @@ import { CfnReplicationConfigurationProps } from '@aws-cdk/aws-ecr' const cfnReplicationConfigurationProps: CfnReplicationConfigurationProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`replicationConfiguration\`](#awscdkawsecrcfnreplicationconfigurationpropspropertyreplicationconfiguration)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | +| replicationConfiguration | @aws-cdk/core.IResolvable \\\\| ReplicationConfigurationProperty | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | --- -##### \`replicationConfiguration\`Required +##### \`replicationConfiguration\`Required \`\`\`typescript public readonly replicationConfiguration: IResolvable | ReplicationConfigurationProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty) +- *Type:* @aws-cdk/core.IResolvable | ReplicationConfigurationProperty \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. @@ -80320,13 +82476,13 @@ public readonly replicationConfiguration: IResolvable | ReplicationConfiguration --- -### CfnRepositoryProps +### CfnRepositoryProps Properties for defining a \`AWS::ECR::Repository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) -#### Initializer +#### Initializer \`\`\`typescript import { CfnRepositoryProps } from '@aws-cdk/aws-ecr' @@ -80334,27 +82490,27 @@ import { CfnRepositoryProps } from '@aws-cdk/aws-ecr' const cfnRepositoryProps: CfnRepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`encryptionConfiguration\`](#awscdkawsecrcfnrepositorypropspropertyencryptionconfiguration) | \`any\` | \`AWS::ECR::Repository.EncryptionConfiguration\`. | -| [\`imageScanningConfiguration\`](#awscdkawsecrcfnrepositorypropspropertyimagescanningconfiguration) | \`any\` | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | -| [\`imageTagMutability\`](#awscdkawsecrcfnrepositorypropspropertyimagetagmutability) | \`string\` | \`AWS::ECR::Repository.ImageTagMutability\`. | -| [\`lifecyclePolicy\`](#awscdkawsecrcfnrepositorypropspropertylifecyclepolicy) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) | \`AWS::ECR::Repository.LifecyclePolicy\`. | -| [\`repositoryName\`](#awscdkawsecrcfnrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::Repository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnrepositorypropspropertyrepositorypolicytext) | \`any\` | \`AWS::ECR::Repository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnrepositorypropspropertytags) | [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] | \`AWS::ECR::Repository.Tags\`. | +| encryptionConfiguration | any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| imageScanningConfiguration | any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| imageTagMutability | string | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecyclePolicy | @aws-cdk/core.IResolvable \\\\| LifecyclePolicyProperty | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repositoryName | string | \`AWS::ECR::Repository.RepositoryName\`. | +| repositoryPolicyText | any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | @aws-cdk/core.CfnTag[] | \`AWS::ECR::Repository.Tags\`. | --- -##### \`encryptionConfiguration\`Optional +##### \`encryptionConfiguration\`Optional \`\`\`typescript public readonly encryptionConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.EncryptionConfiguration\`. @@ -80362,13 +82518,13 @@ public readonly encryptionConfiguration: any; --- -##### \`imageScanningConfiguration\`Optional +##### \`imageScanningConfiguration\`Optional \`\`\`typescript public readonly imageScanningConfiguration: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.ImageScanningConfiguration\`. @@ -80376,13 +82532,13 @@ public readonly imageScanningConfiguration: any; --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.ImageTagMutability\`. @@ -80390,13 +82546,13 @@ public readonly imageTagMutability: string; --- -##### \`lifecyclePolicy\`Optional +##### \`lifecyclePolicy\`Optional \`\`\`typescript public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty\`](#@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty) +- *Type:* @aws-cdk/core.IResolvable | LifecyclePolicyProperty \`AWS::ECR::Repository.LifecyclePolicy\`. @@ -80404,13 +82560,13 @@ public readonly lifecyclePolicy: IResolvable | LifecyclePolicyProperty; --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::Repository.RepositoryName\`. @@ -80418,13 +82574,13 @@ public readonly repositoryName: string; --- -##### \`repositoryPolicyText\`Optional +##### \`repositoryPolicyText\`Optional \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::Repository.RepositoryPolicyText\`. @@ -80432,13 +82588,13 @@ public readonly repositoryPolicyText: any; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] +- *Type:* @aws-cdk/core.CfnTag[] \`AWS::ECR::Repository.Tags\`. @@ -80446,11 +82602,11 @@ public readonly tags: CfnTag[]; --- -### LifecyclePolicyProperty +### LifecyclePolicyProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) -#### Initializer +#### Initializer \`\`\`typescript import { LifecyclePolicyProperty } from '@aws-cdk/aws-ecr' @@ -80458,22 +82614,22 @@ import { LifecyclePolicyProperty } from '@aws-cdk/aws-ecr' const lifecyclePolicyProperty: LifecyclePolicyProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`lifecyclePolicyText\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertylifecyclepolicytext) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | -| [\`registryId\`](#awscdkawsecrcfnrepositorylifecyclepolicypropertypropertyregistryid) | \`string\` | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | +| lifecyclePolicyText | string | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registryId | string | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | --- -##### \`lifecyclePolicyText\`Optional +##### \`lifecyclePolicyText\`Optional \`\`\`typescript public readonly lifecyclePolicyText: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. @@ -80481,13 +82637,13 @@ public readonly lifecyclePolicyText: string; --- -##### \`registryId\`Optional +##### \`registryId\`Optional \`\`\`typescript public readonly registryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. @@ -80495,11 +82651,11 @@ public readonly registryId: string; --- -### LifecycleRule +### LifecycleRule An ECR life cycle rule. -#### Initializer +#### Initializer \`\`\`typescript import { LifecycleRule } from '@aws-cdk/aws-ecr' @@ -80507,39 +82663,39 @@ import { LifecycleRule } from '@aws-cdk/aws-ecr' const lifecycleRule: LifecycleRule = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecrlifecyclerulepropertydescription) | \`string\` | Describes the purpose of the rule. | -| [\`maxImageAge\`](#awscdkawsecrlifecyclerulepropertymaximageage) | [\`@aws-cdk/core.Duration\`](#@aws-cdk/core.Duration) | The maximum age of images to retain. The value must represent a number of days. | -| [\`maxImageCount\`](#awscdkawsecrlifecyclerulepropertymaximagecount) | \`number\` | The maximum number of images to retain. | -| [\`rulePriority\`](#awscdkawsecrlifecyclerulepropertyrulepriority) | \`number\` | Controls the order in which rules are evaluated (low to high). | -| [\`tagPrefixList\`](#awscdkawsecrlifecyclerulepropertytagprefixlist) | \`string\`[] | Select images that have ALL the given prefixes in their tag. | -| [\`tagStatus\`](#awscdkawsecrlifecyclerulepropertytagstatus) | [\`@aws-cdk/aws-ecr.TagStatus\`](#@aws-cdk/aws-ecr.TagStatus) | Select images based on tags. | +| description | string | Describes the purpose of the rule. | +| maxImageAge | @aws-cdk/core.Duration | The maximum age of images to retain. The value must represent a number of days. | +| maxImageCount | number | The maximum number of images to retain. | +| rulePriority | number | Controls the order in which rules are evaluated (low to high). | +| tagPrefixList | string[] | Select images that have ALL the given prefixes in their tag. | +| tagStatus | TagStatus | Select images based on tags. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description Describes the purpose of the rule. --- -##### \`maxImageAge\`Optional +##### \`maxImageAge\`Optional \`\`\`typescript public readonly maxImageAge: Duration; \`\`\` -- *Type:* [\`@aws-cdk/core.Duration\`](#@aws-cdk/core.Duration) +- *Type:* @aws-cdk/core.Duration The maximum age of images to retain. The value must represent a number of days. @@ -80547,13 +82703,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`maxImageCount\`Optional +##### \`maxImageCount\`Optional \`\`\`typescript public readonly maxImageCount: number; \`\`\` -- *Type:* \`number\` +- *Type:* number The maximum number of images to retain. @@ -80561,13 +82717,13 @@ Specify exactly one of maxImageCount and maxImageAge. --- -##### \`rulePriority\`Optional +##### \`rulePriority\`Optional \`\`\`typescript public readonly rulePriority: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* Automatically assigned Controls the order in which rules are evaluated (low to high). @@ -80576,13 +82732,13 @@ All rules must have a unique priority, where lower numbers have higher precedenc --- -##### \`tagPrefixList\`Optional +##### \`tagPrefixList\`Optional \`\`\`typescript public readonly tagPrefixList: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] Select images that have ALL the given prefixes in their tag. @@ -80590,13 +82746,13 @@ Only if tagStatus == TagStatus.Tagged --- -##### \`tagStatus\`Optional +##### \`tagStatus\`Optional \`\`\`typescript public readonly tagStatus: TagStatus; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.TagStatus\`](#@aws-cdk/aws-ecr.TagStatus) +- *Type:* TagStatus - *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise Select images based on tags. @@ -80605,11 +82761,11 @@ Only one rule is allowed to select untagged images, and it must have the highest --- -### OnCloudTrailImagePushedOptions +### OnCloudTrailImagePushedOptions Options for the onCloudTrailImagePushed method. -#### Initializer +#### Initializer \`\`\`typescript import { OnCloudTrailImagePushedOptions } from '@aws-cdk/aws-ecr' @@ -80617,92 +82773,92 @@ import { OnCloudTrailImagePushedOptions } from '@aws-cdk/aws-ecr' const onCloudTrailImagePushedOptions: OnCloudTrailImagePushedOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecroncloudtrailimagepushedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`eventPattern\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyeventpattern) | [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`target\`](#awscdkawsecroncloudtrailimagepushedoptionspropertytarget) | [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) | The target to register for the event. | -| [\`imageTag\`](#awscdkawsecroncloudtrailimagepushedoptionspropertyimagetag) | \`string\` | Only watch changes to this image tag. | +| description | string | A description of the rule's purpose. | +| eventPattern | @aws-cdk/aws-events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | string | A name for the rule. | +| target | @aws-cdk/aws-events.IRuleTarget | The target to register for the event. | +| imageTag | string | Only watch changes to this image tag. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`typescript public readonly eventPattern: EventPattern; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) +- *Type:* @aws-cdk/aws-events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`typescript public readonly ruleName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`typescript public readonly target: IRuleTarget; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) +- *Type:* @aws-cdk/aws-events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTag\`Optional +##### \`imageTag\`Optional \`\`\`typescript public readonly imageTag: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -### OnImageScanCompletedOptions +### OnImageScanCompletedOptions Options for the OnImageScanCompleted method. -#### Initializer +#### Initializer \`\`\`typescript import { OnImageScanCompletedOptions } from '@aws-cdk/aws-ecr' @@ -80710,81 +82866,81 @@ import { OnImageScanCompletedOptions } from '@aws-cdk/aws-ecr' const onImageScanCompletedOptions: OnImageScanCompletedOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`description\`](#awscdkawsecronimagescancompletedoptionspropertydescription) | \`string\` | A description of the rule's purpose. | -| [\`eventPattern\`](#awscdkawsecronimagescancompletedoptionspropertyeventpattern) | [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) | Additional restrictions for the event to route to the specified target. | -| [\`ruleName\`](#awscdkawsecronimagescancompletedoptionspropertyrulename) | \`string\` | A name for the rule. | -| [\`target\`](#awscdkawsecronimagescancompletedoptionspropertytarget) | [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) | The target to register for the event. | -| [\`imageTags\`](#awscdkawsecronimagescancompletedoptionspropertyimagetags) | \`string\`[] | Only watch changes to the image tags spedified. | +| description | string | A description of the rule's purpose. | +| eventPattern | @aws-cdk/aws-events.EventPattern | Additional restrictions for the event to route to the specified target. | +| ruleName | string | A name for the rule. | +| target | @aws-cdk/aws-events.IRuleTarget | The target to register for the event. | +| imageTags | string[] | Only watch changes to the image tags spedified. | --- -##### \`description\`Optional +##### \`description\`Optional \`\`\`typescript public readonly description: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No description A description of the rule's purpose. --- -##### \`eventPattern\`Optional +##### \`eventPattern\`Optional \`\`\`typescript public readonly eventPattern: EventPattern; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.EventPattern\`](#@aws-cdk/aws-events.EventPattern) +- *Type:* @aws-cdk/aws-events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -##### \`ruleName\`Optional +##### \`ruleName\`Optional \`\`\`typescript public readonly ruleName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -##### \`target\`Optional +##### \`target\`Optional \`\`\`typescript public readonly target: IRuleTarget; \`\`\` -- *Type:* [\`@aws-cdk/aws-events.IRuleTarget\`](#@aws-cdk/aws-events.IRuleTarget) +- *Type:* @aws-cdk/aws-events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -##### \`imageTags\`Optional +##### \`imageTags\`Optional \`\`\`typescript public readonly imageTags: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -80793,11 +82949,11 @@ Leave it undefined to watch the full repository. --- -### ReplicationConfigurationProperty +### ReplicationConfigurationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationConfigurationProperty } from '@aws-cdk/aws-ecr' @@ -80805,21 +82961,21 @@ import { ReplicationConfigurationProperty } from '@aws-cdk/aws-ecr' const replicationConfigurationProperty: ReplicationConfigurationProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`rules\`](#awscdkawsecrcfnreplicationconfigurationreplicationconfigurationpropertypropertyrules)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty)[] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | +| rules | @aws-cdk/core.IResolvable \\\\| @aws-cdk/core.IResolvable \\\\| ReplicationRuleProperty[] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | --- -##### \`rules\`Required +##### \`rules\`Required \`\`\`typescript public readonly rules: IResolvable | IResolvable | ReplicationRuleProperty[]; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty)[] +- *Type:* @aws-cdk/core.IResolvable | @aws-cdk/core.IResolvable | ReplicationRuleProperty[] \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. @@ -80827,11 +82983,11 @@ public readonly rules: IResolvable | IResolvable | ReplicationRuleProperty[]; --- -### ReplicationDestinationProperty +### ReplicationDestinationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationDestinationProperty } from '@aws-cdk/aws-ecr' @@ -80839,22 +82995,22 @@ import { ReplicationDestinationProperty } from '@aws-cdk/aws-ecr' const replicationDestinationProperty: ReplicationDestinationProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`region\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregion)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | -| [\`registryId\`](#awscdkawsecrcfnreplicationconfigurationreplicationdestinationpropertypropertyregistryid)* | \`string\` | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | +| region | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registryId | string | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | --- -##### \`region\`Required +##### \`region\`Required \`\`\`typescript public readonly region: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. @@ -80862,13 +83018,13 @@ public readonly region: string; --- -##### \`registryId\`Required +##### \`registryId\`Required \`\`\`typescript public readonly registryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. @@ -80876,11 +83032,11 @@ public readonly registryId: string; --- -### ReplicationRuleProperty +### ReplicationRuleProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) -#### Initializer +#### Initializer \`\`\`typescript import { ReplicationRuleProperty } from '@aws-cdk/aws-ecr' @@ -80888,21 +83044,21 @@ import { ReplicationRuleProperty } from '@aws-cdk/aws-ecr' const replicationRuleProperty: ReplicationRuleProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`destinations\`](#awscdkawsecrcfnreplicationconfigurationreplicationrulepropertypropertydestinations)* | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) \\\\| [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)[] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | +| destinations | @aws-cdk/core.IResolvable \\\\| @aws-cdk/core.IResolvable \\\\| ReplicationDestinationProperty[] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | --- -##### \`destinations\`Required +##### \`destinations\`Required \`\`\`typescript public readonly destinations: IResolvable | IResolvable | ReplicationDestinationProperty[]; \`\`\` -- *Type:* [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/core.IResolvable\`](#@aws-cdk/core.IResolvable) | [\`@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty\`](#@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty)[] +- *Type:* @aws-cdk/core.IResolvable | @aws-cdk/core.IResolvable | ReplicationDestinationProperty[] \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. @@ -80910,9 +83066,9 @@ public readonly destinations: IResolvable | IResolvable | ReplicationDestination --- -### RepositoryAttributes +### RepositoryAttributes -#### Initializer +#### Initializer \`\`\`typescript import { RepositoryAttributes } from '@aws-cdk/aws-ecr' @@ -80920,38 +83076,38 @@ import { RepositoryAttributes } from '@aws-cdk/aws-ecr' const repositoryAttributes: RepositoryAttributes = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryArn\`](#awscdkawsecrrepositoryattributespropertyrepositoryarn)* | \`string\` | *No description.* | -| [\`repositoryName\`](#awscdkawsecrrepositoryattributespropertyrepositoryname)* | \`string\` | *No description.* | +| repositoryArn | string | *No description.* | +| repositoryName | string | *No description.* | --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -### RepositoryProps +### RepositoryProps -#### Initializer +#### Initializer \`\`\`typescript import { RepositoryProps } from '@aws-cdk/aws-ecr' @@ -80959,39 +83115,39 @@ import { RepositoryProps } from '@aws-cdk/aws-ecr' const repositoryProps: RepositoryProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`imageScanOnPush\`](#awscdkawsecrrepositorypropspropertyimagescanonpush) | \`boolean\` | Enable the scan on push when creating the repository. | -| [\`imageTagMutability\`](#awscdkawsecrrepositorypropspropertyimagetagmutability) | [\`@aws-cdk/aws-ecr.TagMutability\`](#@aws-cdk/aws-ecr.TagMutability) | The tag mutability setting for the repository. | -| [\`lifecycleRegistryId\`](#awscdkawsecrrepositorypropspropertylifecycleregistryid) | \`string\` | The AWS account ID associated with the registry that contains the repository. | -| [\`lifecycleRules\`](#awscdkawsecrrepositorypropspropertylifecyclerules) | [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule)[] | Life cycle rules to apply to this registry. | -| [\`removalPolicy\`](#awscdkawsecrrepositorypropspropertyremovalpolicy) | [\`@aws-cdk/core.RemovalPolicy\`](#@aws-cdk/core.RemovalPolicy) | Determine what happens to the repository when the resource/stack is deleted. | -| [\`repositoryName\`](#awscdkawsecrrepositorypropspropertyrepositoryname) | \`string\` | Name for this repository. | +| imageScanOnPush | boolean | Enable the scan on push when creating the repository. | +| imageTagMutability | TagMutability | The tag mutability setting for the repository. | +| lifecycleRegistryId | string | The AWS account ID associated with the registry that contains the repository. | +| lifecycleRules | LifecycleRule[] | Life cycle rules to apply to this registry. | +| removalPolicy | @aws-cdk/core.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repositoryName | string | Name for this repository. | --- -##### \`imageScanOnPush\`Optional +##### \`imageScanOnPush\`Optional \`\`\`typescript public readonly imageScanOnPush: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Enable the scan on push when creating the repository. --- -##### \`imageTagMutability\`Optional +##### \`imageTagMutability\`Optional \`\`\`typescript public readonly imageTagMutability: TagMutability; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.TagMutability\`](#@aws-cdk/aws-ecr.TagMutability) +- *Type:* TagMutability - *Default:* TagMutability.MUTABLE The tag mutability setting for the repository. @@ -81000,78 +83156,78 @@ If this parameter is omitted, the default setting of MUTABLE will be used which --- -##### \`lifecycleRegistryId\`Optional +##### \`lifecycleRegistryId\`Optional \`\`\`typescript public readonly lifecycleRegistryId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The default registry is assumed. The AWS account ID associated with the registry that contains the repository. -> https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) --- -##### \`lifecycleRules\`Optional +##### \`lifecycleRules\`Optional \`\`\`typescript public readonly lifecycleRules: LifecycleRule[]; \`\`\` -- *Type:* [\`@aws-cdk/aws-ecr.LifecycleRule\`](#@aws-cdk/aws-ecr.LifecycleRule)[] +- *Type:* LifecycleRule[] - *Default:* No life cycle rules Life cycle rules to apply to this registry. --- -##### \`removalPolicy\`Optional +##### \`removalPolicy\`Optional \`\`\`typescript public readonly removalPolicy: RemovalPolicy; \`\`\` -- *Type:* [\`@aws-cdk/core.RemovalPolicy\`](#@aws-cdk/core.RemovalPolicy) +- *Type:* @aws-cdk/core.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine what happens to the repository when the resource/stack is deleted. --- -##### \`repositoryName\`Optional +##### \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name. Name for this repository. --- -## Classes +## Classes -### AuthorizationToken +### AuthorizationToken Authorization token to access private ECR repositories in the current environment via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#awscdkawsecrauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`typescript import { AuthorizationToken } from '@aws-cdk/aws-ecr' @@ -81079,30 +83235,30 @@ import { AuthorizationToken } from '@aws-cdk/aws-ecr' AuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -### PublicGalleryAuthorizationToken +### PublicGalleryAuthorizationToken Authorization token to access the global public ECR Gallery via Docker CLI. -> https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`grantRead\`](#awscdkawsecrpublicgalleryauthorizationtokengrantread) | Grant access to retrieve an authorization token. | +| grantRead | Grant access to retrieve an authorization token. | --- -##### \`grantRead\` +##### \`grantRead\` \`\`\`typescript import { PublicGalleryAuthorizationToken } from '@aws-cdk/aws-ecr' @@ -81110,239 +83266,239 @@ import { PublicGalleryAuthorizationToken } from '@aws-cdk/aws-ecr' PublicGalleryAuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -## Protocols +## Protocols -### IRepository +### IRepository -- *Extends:* [\`@aws-cdk/core.IResource\`](#@aws-cdk/core.IResource) +- *Extends:* @aws-cdk/core.IResource -- *Implemented By:* [\`@aws-cdk/aws-ecr.Repository\`](#@aws-cdk/aws-ecr.Repository), [\`@aws-cdk/aws-ecr.RepositoryBase\`](#@aws-cdk/aws-ecr.RepositoryBase), [\`@aws-cdk/aws-ecr.IRepository\`](#@aws-cdk/aws-ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -##### \`addToResourcePolicy\` +##### \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -##### \`grant\` +##### \`grant\` \`\`\`typescript public grant(grantee: IGrantable, actions: string) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -###### \`actions\`Required +###### \`actions\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`grantPull\` +##### \`grantPull\` \`\`\`typescript public grantPull(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`grantPullPush\` +##### \`grantPullPush\` \`\`\`typescript public grantPullPush(grantee: IGrantable) \`\`\` -###### \`grantee\`Required +###### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -##### \`onCloudTrailEvent\` +##### \`onCloudTrailEvent\` \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- -##### \`onCloudTrailImagePushed\` +##### \`onCloudTrailImagePushed\` \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions\`](#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -##### \`onEvent\` +##### \`onEvent\` \`\`\`typescript public onEvent(id: string, options?: OnEventOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions --- -##### \`onImageScanCompleted\` +##### \`onImageScanCompleted\` \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnImageScanCompletedOptions\`](#@aws-cdk/aws-ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -##### \`repositoryUriForDigest\` +##### \`repositoryUriForDigest\` \`\`\`typescript public repositoryUriForDigest(digest?: string) \`\`\` -###### \`digest\`Optional +###### \`digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -##### \`repositoryUriForTag\` +##### \`repositoryUriForTag\` \`\`\`typescript public repositoryUriForTag(tag?: string) \`\`\` -###### \`tag\`Optional +###### \`tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`repositoryUri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| node | @aws-cdk/core.ConstructNode | The construct tree node for this construct. | +| env | @aws-cdk/core.ResourceEnvironment | The environment this resource belongs to. | +| stack | @aws-cdk/core.Stack | The stack in which this resource is defined. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | +| repositoryUri | string | The URI of this repository (represents the latest image):. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`typescript public readonly node: ConstructNode; \`\`\` -- *Type:* [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) +- *Type:* @aws-cdk/core.ConstructNode The construct tree node for this construct. --- -##### \`env\`Required +##### \`env\`Required \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` -- *Type:* [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) +- *Type:* @aws-cdk/core.ResourceEnvironment The environment this resource belongs to. @@ -81350,49 +83506,49 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`typescript public readonly stack: Stack; \`\`\` -- *Type:* [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) +- *Type:* @aws-cdk/core.Stack The stack in which this resource is defined. --- -##### \`repositoryArn\`Required +##### \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -##### \`repositoryName\`Required +##### \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -##### \`repositoryUri\`Required +##### \`repositoryUri\`Required \`\`\`typescript public readonly repositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -81400,60 +83556,60 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- -## Enums +## Enums -### TagMutability +### TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -#### \`MUTABLE\` +#### \`MUTABLE\` allow image tags to be overwritten. --- -#### \`IMMUTABLE\` +#### \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. --- -### TagStatus +### TagStatus | **Name** | **Description** | | --- | --- | -| [\`ANY\`](#awscdkawsecrtagstatusany) | Rule applies to all images. | -| [\`TAGGED\`](#awscdkawsecrtagstatustagged) | Rule applies to tagged images. | -| [\`UNTAGGED\`](#awscdkawsecrtagstatusuntagged) | Rule applies to untagged images. | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | --- Select images based on tags. -#### \`ANY\` +#### \`ANY\` Rule applies to all images. --- -#### \`TAGGED\` +#### \`TAGGED\` Rule applies to tagged images. --- -#### \`UNTAGGED\` +#### \`UNTAGGED\` Rule applies to untagged images. @@ -82676,15 +84832,15 @@ Kubernetes [endpoint access](#endpoint-access), you must also specify: # API Reference -## Constructs +## Constructs -### AwsAuth +### AwsAuth Manages mapping between IAM users and roles to Kubernetes RBAC configuration. -> https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html +> [https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html](https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -82694,116 +84850,116 @@ new aws_eks.AwsAuth(scope: Construct, id: string, props: AwsAuthProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksawsauthparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawseksawsauthparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawseksawsauthparameterprops)* | [\`aws-cdk-lib.aws_eks.AwsAuthProps\`](#aws-cdk-lib.aws_eks.AwsAuthProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | AwsAuthProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.AwsAuthProps\`](#aws-cdk-lib.aws_eks.AwsAuthProps) +- *Type:* AwsAuthProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAccount\`](#awscdklibawseksawsauthaddaccount) | Additional AWS account to add to the aws-auth configmap. | -| [\`addMastersRole\`](#awscdklibawseksawsauthaddmastersrole) | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | -| [\`addRoleMapping\`](#awscdklibawseksawsauthaddrolemapping) | Adds a mapping between an IAM role to a Kubernetes user and groups. | -| [\`addUserMapping\`](#awscdklibawseksawsauthaddusermapping) | Adds a mapping between an IAM user to a Kubernetes user and groups. | +| addAccount | Additional AWS account to add to the aws-auth configmap. | +| addMastersRole | Adds the specified IAM role to the \`system:masters\` RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system. | +| addRoleMapping | Adds a mapping between an IAM role to a Kubernetes user and groups. | +| addUserMapping | Adds a mapping between an IAM user to a Kubernetes user and groups. | --- -##### \`addAccount\` +##### \`addAccount\` \`\`\`typescript public addAccount(accountId: string) \`\`\` -###### \`accountId\`Required +###### \`accountId\`Required -- *Type:* \`string\` +- *Type:* string account number. --- -##### \`addMastersRole\` +##### \`addMastersRole\` \`\`\`typescript public addMastersRole(role: IRole, username?: string) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole The IAM role to add. --- -###### \`username\`Optional +###### \`username\`Optional -- *Type:* \`string\` +- *Type:* string Optional user (defaults to the role ARN). --- -##### \`addRoleMapping\` +##### \`addRoleMapping\` \`\`\`typescript public addRoleMapping(role: IRole, mapping: AwsAuthMapping) \`\`\` -###### \`role\`Required +###### \`role\`Required -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole The IAM role to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.AwsAuthMapping\`](#aws-cdk-lib.aws_eks.AwsAuthMapping) +- *Type:* AwsAuthMapping Mapping to k8s user name and groups. --- -##### \`addUserMapping\` +##### \`addUserMapping\` \`\`\`typescript public addUserMapping(user: IUser, mapping: AwsAuthMapping) \`\`\` -###### \`user\`Required +###### \`user\`Required -- *Type:* [\`aws-cdk-lib.aws_iam.IUser\`](#aws-cdk-lib.aws_iam.IUser) +- *Type:* aws-cdk-lib.aws_iam.IUser The IAM user to map. --- -###### \`mapping\`Required +###### \`mapping\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.AwsAuthMapping\`](#aws-cdk-lib.aws_eks.AwsAuthMapping) +- *Type:* AwsAuthMapping Mapping to k8s user name and groups. @@ -82812,15 +84968,15 @@ Mapping to k8s user name and groups. -### CfnAddon +### CfnAddon -- *Implements:* [\`aws-cdk-lib.IInspectable\`](#aws-cdk-lib.IInspectable) +- *Implements:* aws-cdk-lib.IInspectable A CloudFormation \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -82830,90 +84986,90 @@ new aws_eks.CfnAddon(scope: Construct, id: string, props: CfnAddonProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekscfnaddonparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdklibawsekscfnaddonparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdklibawsekscfnaddonparameterprops)* | [\`aws-cdk-lib.aws_eks.CfnAddonProps\`](#aws-cdk-lib.aws_eks.CfnAddonProps) | resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnAddonProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.CfnAddonProps\`](#aws-cdk-lib.aws_eks.CfnAddonProps) +- *Type:* CfnAddonProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdklibawsekscfnaddoninspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws-cdk-lib.TreeInspector\`](#aws-cdk-lib.TreeInspector) +- *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdklibawsekscfnaddonpropertyattrarn)* | \`string\` | *No description.* | -| [\`tags\`](#awscdklibawsekscfnaddonpropertytags)* | [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) | \`AWS::EKS::Addon.Tags\`. | -| [\`addonName\`](#awscdklibawsekscfnaddonpropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#awscdklibawsekscfnaddonpropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#awscdklibawsekscfnaddonpropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#awscdklibawsekscfnaddonpropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#awscdklibawsekscfnaddonpropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| attrArn | string | *No description.* | +| tags | aws-cdk-lib.TagManager | \`AWS::EKS::Addon.Tags\`. | +| addonName | string | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) +- *Type:* aws-cdk-lib.TagManager \`AWS::EKS::Addon.Tags\`. @@ -82921,13 +85077,13 @@ public readonly tags: TagManager; --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`typescript public readonly addonName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -82935,13 +85091,13 @@ public readonly addonName: string; --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -82949,13 +85105,13 @@ public readonly clusterName: string; --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`typescript public readonly addonVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -82963,13 +85119,13 @@ public readonly addonVersion: string; --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`typescript public readonly resolveConflicts: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -82977,13 +85133,13 @@ public readonly resolveConflicts: string; --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`typescript public readonly serviceAccountRoleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -82991,31 +85147,35 @@ public readonly serviceAccountRoleArn: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdklibawsekscfnaddonpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` + +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnCluster +### CfnCluster -- *Implements:* [\`aws-cdk-lib.IInspectable\`](#aws-cdk-lib.IInspectable) +- *Implements:* aws-cdk-lib.IInspectable A CloudFormation \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -83025,145 +85185,145 @@ new aws_eks.CfnCluster(scope: Construct, id: string, props: CfnClusterProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekscfnclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdklibawsekscfnclusterparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdklibawsekscfnclusterparameterprops)* | [\`aws-cdk-lib.aws_eks.CfnClusterProps\`](#aws-cdk-lib.aws_eks.CfnClusterProps) | resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnClusterProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.CfnClusterProps\`](#aws-cdk-lib.aws_eks.CfnClusterProps) +- *Type:* CfnClusterProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdklibawsekscfnclusterinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws-cdk-lib.TreeInspector\`](#aws-cdk-lib.TreeInspector) +- *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdklibawsekscfnclusterpropertyattrarn)* | \`string\` | *No description.* | -| [\`attrCertificateAuthorityData\`](#awscdklibawsekscfnclusterpropertyattrcertificateauthoritydata)* | \`string\` | *No description.* | -| [\`attrClusterSecurityGroupId\`](#awscdklibawsekscfnclusterpropertyattrclustersecuritygroupid)* | \`string\` | *No description.* | -| [\`attrEncryptionConfigKeyArn\`](#awscdklibawsekscfnclusterpropertyattrencryptionconfigkeyarn)* | \`string\` | *No description.* | -| [\`attrEndpoint\`](#awscdklibawsekscfnclusterpropertyattrendpoint)* | \`string\` | *No description.* | -| [\`attrOpenIdConnectIssuerUrl\`](#awscdklibawsekscfnclusterpropertyattropenidconnectissuerurl)* | \`string\` | *No description.* | -| [\`resourcesVpcConfig\`](#awscdklibawsekscfnclusterpropertyresourcesvpcconfig)* | [\`aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#awscdklibawsekscfnclusterpropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#awscdklibawsekscfnclusterpropertyencryptionconfig) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#awscdklibawsekscfnclusterpropertykubernetesnetworkconfig) | [\`aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#awscdklibawsekscfnclusterpropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#awscdklibawsekscfnclusterpropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| attrArn | string | *No description.* | +| attrCertificateAuthorityData | string | *No description.* | +| attrClusterSecurityGroupId | string | *No description.* | +| attrEncryptionConfigKeyArn | string | *No description.* | +| attrEndpoint | string | *No description.* | +| attrOpenIdConnectIssuerUrl | string | *No description.* | +| resourcesVpcConfig | ResourcesVpcConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | aws-cdk-lib.IResolvable \\\\| EncryptionConfigProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | KubernetesNetworkConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | string | \`AWS::EKS::Cluster.Name\`. | +| version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrCertificateAuthorityData\`Required +##### \`attrCertificateAuthorityData\`Required \`\`\`typescript public readonly attrCertificateAuthorityData: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrClusterSecurityGroupId\`Required +##### \`attrClusterSecurityGroupId\`Required \`\`\`typescript public readonly attrClusterSecurityGroupId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrEncryptionConfigKeyArn\`Required +##### \`attrEncryptionConfigKeyArn\`Required \`\`\`typescript public readonly attrEncryptionConfigKeyArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrEndpoint\`Required +##### \`attrEndpoint\`Required \`\`\`typescript public readonly attrEndpoint: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrOpenIdConnectIssuerUrl\`Required +##### \`attrOpenIdConnectIssuerUrl\`Required \`\`\`typescript public readonly attrOpenIdConnectIssuerUrl: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`typescript public readonly resourcesVpcConfig: ResourcesVpcConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* ResourcesVpcConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -83171,13 +85331,13 @@ public readonly resourcesVpcConfig: ResourcesVpcConfigProperty | IResolvable; --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`typescript public readonly roleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -83185,13 +85345,13 @@ public readonly roleArn: string; --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`typescript public readonly encryptionConfig: IResolvable | EncryptionConfigProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | EncryptionConfigProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -83199,13 +85359,13 @@ public readonly encryptionConfig: IResolvable | EncryptionConfigProperty | IReso --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`typescript public readonly kubernetesNetworkConfig: KubernetesNetworkConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* KubernetesNetworkConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -83213,13 +85373,13 @@ public readonly kubernetesNetworkConfig: KubernetesNetworkConfigProperty | IReso --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`typescript public readonly name: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -83227,13 +85387,13 @@ public readonly name: string; --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -83241,31 +85401,35 @@ public readonly version: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdklibawsekscfnclusterpropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnFargateProfile +### CfnFargateProfile -- *Implements:* [\`aws-cdk-lib.IInspectable\`](#aws-cdk-lib.IInspectable) +- *Implements:* aws-cdk-lib.IInspectable A CloudFormation \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -83275,90 +85439,90 @@ new aws_eks.CfnFargateProfile(scope: Construct, id: string, props: CfnFargatePro | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekscfnfargateprofileparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdklibawsekscfnfargateprofileparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdklibawsekscfnfargateprofileparameterprops)* | [\`aws-cdk-lib.aws_eks.CfnFargateProfileProps\`](#aws-cdk-lib.aws_eks.CfnFargateProfileProps) | resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnFargateProfileProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.CfnFargateProfileProps\`](#aws-cdk-lib.aws_eks.CfnFargateProfileProps) +- *Type:* CfnFargateProfileProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdklibawsekscfnfargateprofileinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws-cdk-lib.TreeInspector\`](#aws-cdk-lib.TreeInspector) +- *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdklibawsekscfnfargateprofilepropertyattrarn)* | \`string\` | *No description.* | -| [\`tags\`](#awscdklibawsekscfnfargateprofilepropertytags)* | [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) | \`AWS::EKS::FargateProfile.Tags\`. | -| [\`clusterName\`](#awscdklibawsekscfnfargateprofilepropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#awscdklibawsekscfnfargateprofilepropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#awscdklibawsekscfnfargateprofilepropertyselectors)* | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#awscdklibawsekscfnfargateprofilepropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#awscdklibawsekscfnfargateprofilepropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| attrArn | string | *No description.* | +| tags | aws-cdk-lib.TagManager | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | aws-cdk-lib.IResolvable \\\\| SelectorProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) +- *Type:* aws-cdk-lib.TagManager \`AWS::EKS::FargateProfile.Tags\`. @@ -83366,13 +85530,13 @@ public readonly tags: TagManager; --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -83380,13 +85544,13 @@ public readonly clusterName: string; --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`typescript public readonly podExecutionRoleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -83394,13 +85558,13 @@ public readonly podExecutionRoleArn: string; --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`typescript public readonly selectors: IResolvable | SelectorProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | SelectorProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::FargateProfile.Selectors\`. @@ -83408,13 +85572,13 @@ public readonly selectors: IResolvable | SelectorProperty | IResolvable[]; --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`typescript public readonly fargateProfileName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -83422,13 +85586,13 @@ public readonly fargateProfileName: string; --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`typescript public readonly subnets: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -83436,31 +85600,35 @@ public readonly subnets: string[]; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdklibawsekscfnfargateprofilepropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### CfnNodegroup +### CfnNodegroup -- *Implements:* [\`aws-cdk-lib.IInspectable\`](#aws-cdk-lib.IInspectable) +- *Implements:* aws-cdk-lib.IInspectable A CloudFormation \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -83470,123 +85638,123 @@ new aws_eks.CfnNodegroup(scope: Construct, id: string, props: CfnNodegroupProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekscfnnodegroupparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdklibawsekscfnnodegroupparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdklibawsekscfnnodegroupparameterprops)* | [\`aws-cdk-lib.aws_eks.CfnNodegroupProps\`](#aws-cdk-lib.aws_eks.CfnNodegroupProps) | resource properties. | +| scope | constructs.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnNodegroupProps | - resource properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct scope in which this resource is defined. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroupProps\`](#aws-cdk-lib.aws_eks.CfnNodegroupProps) +- *Type:* CfnNodegroupProps resource properties. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`inspect\`](#awscdklibawsekscfnnodegroupinspect) | Examines the CloudFormation resource and discloses attributes. | +| inspect | Examines the CloudFormation resource and discloses attributes. | --- -##### \`inspect\` +##### \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -###### \`inspector\`Required +###### \`inspector\`Required -- *Type:* [\`aws-cdk-lib.TreeInspector\`](#aws-cdk-lib.TreeInspector) +- *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`attrArn\`](#awscdklibawsekscfnnodegrouppropertyattrarn)* | \`string\` | *No description.* | -| [\`attrClusterName\`](#awscdklibawsekscfnnodegrouppropertyattrclustername)* | \`string\` | *No description.* | -| [\`attrNodegroupName\`](#awscdklibawsekscfnnodegrouppropertyattrnodegroupname)* | \`string\` | *No description.* | -| [\`tags\`](#awscdklibawsekscfnnodegrouppropertytags)* | [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`clusterName\`](#awscdklibawsekscfnnodegrouppropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`labels\`](#awscdklibawsekscfnnodegrouppropertylabels)* | \`any\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`nodeRole\`](#awscdklibawsekscfnnodegrouppropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#awscdklibawsekscfnnodegrouppropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#awscdklibawsekscfnnodegrouppropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#awscdklibawsekscfnnodegrouppropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#awscdklibawsekscfnnodegrouppropertydisksize) | \`number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#awscdklibawsekscfnnodegrouppropertyforceupdateenabled) | \`boolean\` \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#awscdklibawsekscfnnodegrouppropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`launchTemplate\`](#awscdklibawsekscfnnodegrouppropertylaunchtemplate) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#awscdklibawsekscfnnodegrouppropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#awscdklibawsekscfnnodegrouppropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#awscdklibawsekscfnnodegrouppropertyremoteaccess) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#awscdklibawsekscfnnodegrouppropertyscalingconfig) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`taints\`](#awscdklibawsekscfnnodegrouppropertytaints) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#awscdklibawsekscfnnodegrouppropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| attrArn | string | *No description.* | +| attrClusterName | string | *No description.* | +| attrNodegroupName | string | *No description.* | +| tags | aws-cdk-lib.TagManager | \`AWS::EKS::Nodegroup.Tags\`. | +| clusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| labels | any | \`AWS::EKS::Nodegroup.Labels\`. | +| nodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | boolean \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| launchTemplate | LaunchTemplateSpecificationProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | RemoteAccessProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | ScalingConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| taints | aws-cdk-lib.IResolvable \\\\| TaintProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::Nodegroup.Taints\`. | +| version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`attrArn\`Required +##### \`attrArn\`Required \`\`\`typescript public readonly attrArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrClusterName\`Required +##### \`attrClusterName\`Required \`\`\`typescript public readonly attrClusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`attrNodegroupName\`Required +##### \`attrNodegroupName\`Required \`\`\`typescript public readonly attrNodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) +- *Type:* aws-cdk-lib.TagManager \`AWS::EKS::Nodegroup.Tags\`. @@ -83594,13 +85762,13 @@ public readonly tags: TagManager; --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -83608,13 +85776,13 @@ public readonly clusterName: string; --- -##### \`labels\`Required +##### \`labels\`Required \`\`\`typescript public readonly labels: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::EKS::Nodegroup.Labels\`. @@ -83622,13 +85790,13 @@ public readonly labels: any; --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`typescript public readonly nodeRole: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -83636,13 +85804,13 @@ public readonly nodeRole: string; --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`typescript public readonly subnets: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -83650,13 +85818,13 @@ public readonly subnets: string[]; --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`typescript public readonly amiType: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -83664,13 +85832,13 @@ public readonly amiType: string; --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`typescript public readonly capacityType: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -83678,13 +85846,13 @@ public readonly capacityType: string; --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`typescript public readonly diskSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -83692,13 +85860,13 @@ public readonly diskSize: number; --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`typescript public readonly forceUpdateEnabled: boolean | IResolvable; \`\`\` -- *Type:* \`boolean\` | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* boolean | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -83706,13 +85874,13 @@ public readonly forceUpdateEnabled: boolean | IResolvable; --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`typescript public readonly instanceTypes: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -83720,13 +85888,13 @@ public readonly instanceTypes: string[]; --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`typescript public readonly launchTemplate: LaunchTemplateSpecificationProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* LaunchTemplateSpecificationProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -83734,13 +85902,13 @@ public readonly launchTemplate: LaunchTemplateSpecificationProperty | IResolvabl --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -83748,13 +85916,13 @@ public readonly nodegroupName: string; --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`typescript public readonly releaseVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -83762,13 +85930,13 @@ public readonly releaseVersion: string; --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`typescript public readonly remoteAccess: RemoteAccessProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* RemoteAccessProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -83776,13 +85944,13 @@ public readonly remoteAccess: RemoteAccessProperty | IResolvable; --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`typescript public readonly scalingConfig: ScalingConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* ScalingConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -83790,13 +85958,13 @@ public readonly scalingConfig: ScalingConfigProperty | IResolvable; --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`typescript public readonly taints: IResolvable | TaintProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | TaintProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::Nodegroup.Taints\`. @@ -83804,13 +85972,13 @@ public readonly taints: IResolvable | TaintProperty | IResolvable[]; --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -83818,31 +85986,35 @@ public readonly version: string; --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`CFN_RESOURCE_TYPE_NAME\`](#awscdklibawsekscfnnodegrouppropertycfnresourcetypename)* | \`string\` | The CloudFormation resource type name for this resource class. | +| CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- -##### \`CFN_RESOURCE_TYPE_NAME\` +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`typescript +public readonly CFN_RESOURCE_TYPE_NAME: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation resource type name for this resource class. --- -### Cluster +### Cluster -- *Implements:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Implements:* ICluster A Cluster represents a managed Kubernetes Service (EKS). This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -83852,251 +86024,251 @@ new aws_eks.Cluster(scope: Construct, id: string, props: ClusterProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | a Construct, most likely a cdk.Stack created. | -| [\`id\`](#awscdklibawseksclusterparameterid)* | \`string\` | the id of the Construct to create. | -| [\`props\`](#awscdklibawseksclusterparameterprops)* | [\`aws-cdk-lib.aws_eks.ClusterProps\`](#aws-cdk-lib.aws_eks.ClusterProps) | properties in the IClusterProps interface. | +| scope | constructs.Construct | a Construct, most likely a cdk.Stack created. | +| id | string | the id of the Construct to create. | +| props | ClusterProps | properties in the IClusterProps interface. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct a Construct, most likely a cdk.Stack created. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string the id of the Construct to create. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.ClusterProps\`](#aws-cdk-lib.aws_eks.ClusterProps) +- *Type:* ClusterProps properties in the IClusterProps interface. --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addAutoScalingGroupCapacity\`](#awscdklibawseksclusteraddautoscalinggroupcapacity) | Add nodes to this EKS cluster. | -| [\`addCdk8sChart\`](#awscdklibawseksclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addFargateProfile\`](#awscdklibawseksclusteraddfargateprofile) | Adds a Fargate profile to this cluster. | -| [\`addHelmChart\`](#awscdklibawseksclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#awscdklibawseksclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addNodegroupCapacity\`](#awscdklibawseksclusteraddnodegroupcapacity) | Add managed nodegroup to this Amazon EKS cluster. | -| [\`addServiceAccount\`](#awscdklibawseksclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | -| [\`connectAutoScalingGroupCapacity\`](#awscdklibawseksclusterconnectautoscalinggroupcapacity) | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | -| [\`getServiceLoadBalancerAddress\`](#awscdklibawseksclustergetserviceloadbalanceraddress) | Fetch the load balancer address of a service of type 'LoadBalancer'. | +| addAutoScalingGroupCapacity | Add nodes to this EKS cluster. | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addFargateProfile | Adds a Fargate profile to this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addNodegroupCapacity | Add managed nodegroup to this Amazon EKS cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | +| connectAutoScalingGroupCapacity | Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster. | +| getServiceLoadBalancerAddress | Fetch the load balancer address of a service of type 'LoadBalancer'. | --- -##### \`addAutoScalingGroupCapacity\` +##### \`addAutoScalingGroupCapacity\` \`\`\`typescript public addAutoScalingGroupCapacity(id: string, options: AutoScalingGroupCapacityOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.AutoScalingGroupCapacityOptions\`](#aws-cdk-lib.aws_eks.AutoScalingGroupCapacityOptions) +- *Type:* AutoScalingGroupCapacityOptions --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`typescript public addCdk8sChart(id: string, chart: Construct) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the cdk8s chart. --- -##### \`addFargateProfile\` +##### \`addFargateProfile\` \`\`\`typescript public addFargateProfile(id: string, options: FargateProfileOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string the id of this profile. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.FargateProfileOptions\`](#aws-cdk-lib.aws_eks.FargateProfileOptions) +- *Type:* FargateProfileOptions profile options. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`typescript public addHelmChart(id: string, options: HelmChartOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.HelmChartOptions\`](#aws-cdk-lib.aws_eks.HelmChartOptions) +- *Type:* HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`typescript public addManifest(id: string, manifest: {[ key: string ]: any}) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} a list of Kubernetes resource specifications. --- -##### \`addNodegroupCapacity\` +##### \`addNodegroupCapacity\` \`\`\`typescript public addNodegroupCapacity(id: string, options?: NodegroupOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string The ID of the nodegroup. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupOptions\`](#aws-cdk-lib.aws_eks.NodegroupOptions) +- *Type:* NodegroupOptions options for creating a new nodegroup. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`typescript public addServiceAccount(id: string, options?: ServiceAccountOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`aws-cdk-lib.aws_eks.ServiceAccountOptions\`](#aws-cdk-lib.aws_eks.ServiceAccountOptions) +- *Type:* ServiceAccountOptions --- -##### \`connectAutoScalingGroupCapacity\` +##### \`connectAutoScalingGroupCapacity\` \`\`\`typescript public connectAutoScalingGroupCapacity(autoScalingGroup: AutoScalingGroup, options: AutoScalingGroupOptions) \`\`\` -###### \`autoScalingGroup\`Required +###### \`autoScalingGroup\`Required -- *Type:* [\`aws-cdk-lib.aws_autoscaling.AutoScalingGroup\`](#aws-cdk-lib.aws_autoscaling.AutoScalingGroup) +- *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup [disable-awslint:ref-via-interface]. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.AutoScalingGroupOptions\`](#aws-cdk-lib.aws_eks.AutoScalingGroupOptions) +- *Type:* AutoScalingGroupOptions options for adding auto scaling groups, like customizing the bootstrap script. --- -##### \`getServiceLoadBalancerAddress\` +##### \`getServiceLoadBalancerAddress\` \`\`\`typescript public getServiceLoadBalancerAddress(serviceName: string, options?: ServiceLoadBalancerAddressOptions) \`\`\` -###### \`serviceName\`Required +###### \`serviceName\`Required -- *Type:* \`string\` +- *Type:* string The name of the service. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`aws-cdk-lib.aws_eks.ServiceLoadBalancerAddressOptions\`](#aws-cdk-lib.aws_eks.ServiceLoadBalancerAddressOptions) +- *Type:* ServiceLoadBalancerAddressOptions Additional operation options. --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromClusterAttributes\`](#awscdklibawseksclusterfromclusterattributes) | Import an existing cluster. | +| fromClusterAttributes | Import an existing cluster. | --- -##### \`fromClusterAttributes\` +##### \`fromClusterAttributes\` \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84104,68 +86276,68 @@ import { aws_eks } from 'aws-cdk-lib' aws_eks.Cluster.fromClusterAttributes(scope: Construct, id: string, attrs: ClusterAttributes) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the construct scope, in most cases 'this'. --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string the id or name to import as. --- -###### \`attrs\`Required +###### \`attrs\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.ClusterAttributes\`](#aws-cdk-lib.aws_eks.ClusterAttributes) +- *Type:* ClusterAttributes the cluster properties to use for importing information. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`adminRole\`](#awscdklibawseksclusterpropertyadminrole)* | [\`aws-cdk-lib.aws_iam.Role\`](#aws-cdk-lib.aws_iam.Role) | An IAM role with administrative permissions to create or update the cluster. | -| [\`awsAuth\`](#awscdklibawseksclusterpropertyawsauth)* | [\`aws-cdk-lib.aws_eks.AwsAuth\`](#aws-cdk-lib.aws_eks.AwsAuth) | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | -| [\`clusterArn\`](#awscdklibawseksclusterpropertyclusterarn)* | \`string\` | The AWS generated ARN for the Cluster resource. | -| [\`clusterCertificateAuthorityData\`](#awscdklibawseksclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#awscdklibawseksclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#awscdklibawseksclusterpropertyclusterendpoint)* | \`string\` | The endpoint URL for the Cluster. | -| [\`clusterName\`](#awscdklibawseksclusterpropertyclustername)* | \`string\` | The Name of the created EKS Cluster. | -| [\`clusterOpenIdConnectIssuer\`](#awscdklibawseksclusterpropertyclusteropenidconnectissuer)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | -| [\`clusterOpenIdConnectIssuerUrl\`](#awscdklibawseksclusterpropertyclusteropenidconnectissuerurl)* | \`string\` | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | -| [\`clusterSecurityGroup\`](#awscdklibawseksclusterpropertyclustersecuritygroup)* | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#awscdklibawseksclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`connections\`](#awscdklibawseksclusterpropertyconnections)* | [\`aws-cdk-lib.aws_ec2.Connections\`](#aws-cdk-lib.aws_ec2.Connections) | Manages connection rules (Security Group Rules) for the cluster. | -| [\`openIdConnectProvider\`](#awscdklibawseksclusterpropertyopenidconnectprovider)* | [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | -| [\`prune\`](#awscdklibawseksclusterpropertyprune)* | \`boolean\` | Determines if Kubernetes resources can be pruned automatically. | -| [\`role\`](#awscdklibawseksclusterpropertyrole)* | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | IAM role assumed by the EKS Control Plane. | -| [\`vpc\`](#awscdklibawseksclusterpropertyvpc)* | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`defaultCapacity\`](#awscdklibawseksclusterpropertydefaultcapacity) | [\`aws-cdk-lib.aws_autoscaling.AutoScalingGroup\`](#aws-cdk-lib.aws_autoscaling.AutoScalingGroup) | The auto scaling group that hosts the default capacity for this cluster. | -| [\`defaultNodegroup\`](#awscdklibawseksclusterpropertydefaultnodegroup) | [\`aws-cdk-lib.aws_eks.Nodegroup\`](#aws-cdk-lib.aws_eks.Nodegroup) | The node group that hosts the default capacity for this cluster. | -| [\`kubectlEnvironment\`](#awscdklibawseksclusterpropertykubectlenvironment) | {[ key: string ]: \`string\`} | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#awscdklibawseksclusterpropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | -| [\`kubectlMemory\`](#awscdklibawseksclusterpropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | The amount of memory allocated to the kubectl provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#awscdklibawseksclusterpropertykubectlprivatesubnets) | [\`aws-cdk-lib.aws_ec2.ISubnet\`](#aws-cdk-lib.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#awscdklibawseksclusterpropertykubectlrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#awscdklibawseksclusterpropertykubectlsecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| adminRole | aws-cdk-lib.aws_iam.Role | An IAM role with administrative permissions to create or update the cluster. | +| awsAuth | AwsAuth | Lazily creates the AwsAuth resource, which manages AWS authentication mapping. | +| clusterArn | string | The AWS generated ARN for the Cluster resource. | +| clusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | string | The endpoint URL for the Cluster. | +| clusterName | string | The Name of the created EKS Cluster. | +| clusterOpenIdConnectIssuer | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer. | +| clusterOpenIdConnectIssuerUrl | string | If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. | +| clusterSecurityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| connections | aws-cdk-lib.aws_ec2.Connections | Manages connection rules (Security Group Rules) for the cluster. | +| openIdConnectProvider | aws-cdk-lib.aws_iam.IOpenIdConnectProvider | An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. | +| prune | boolean | Determines if Kubernetes resources can be pruned automatically. | +| role | aws-cdk-lib.aws_iam.IRole | IAM role assumed by the EKS Control Plane. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| defaultCapacity | aws-cdk-lib.aws_autoscaling.AutoScalingGroup | The auto scaling group that hosts the default capacity for this cluster. | +| defaultNodegroup | Nodegroup | The node group that hosts the default capacity for this cluster. | +| kubectlEnvironment | {[ key: string ]: string} | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. | +| kubectlMemory | aws-cdk-lib.Size | The amount of memory allocated to the kubectl provider's lambda function. | +| kubectlPrivateSubnets | aws-cdk-lib.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | aws-cdk-lib.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`adminRole\`Required +##### \`adminRole\`Required \`\`\`typescript public readonly adminRole: Role; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.Role\`](#aws-cdk-lib.aws_iam.Role) +- *Type:* aws-cdk-lib.aws_iam.Role An IAM role with administrative permissions to create or update the cluster. @@ -84173,61 +86345,61 @@ This role also has \`systems:master\` permissions. --- -##### \`awsAuth\`Required +##### \`awsAuth\`Required \`\`\`typescript public readonly awsAuth: AwsAuth; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.AwsAuth\`](#aws-cdk-lib.aws_eks.AwsAuth) +- *Type:* AwsAuth Lazily creates the AwsAuth resource, which manages AWS authentication mapping. --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`typescript public readonly clusterArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The AWS generated ARN for the Cluster resource. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`typescript public readonly clusterCertificateAuthorityData: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`typescript public readonly clusterEncryptionConfigKeyArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`typescript public readonly clusterEndpoint: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The endpoint URL for the Cluster. @@ -84235,25 +86407,25 @@ This is the URL inside the kubeconfig file to use with kubectl --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The Name of the created EKS Cluster. --- -##### \`clusterOpenIdConnectIssuer\`Required +##### \`clusterOpenIdConnectIssuer\`Required \`\`\`typescript public readonly clusterOpenIdConnectIssuer: string; \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer. @@ -84261,13 +86433,13 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterOpenIdConnectIssuerUrl\`Required +##### \`clusterOpenIdConnectIssuerUrl\`Required \`\`\`typescript public readonly clusterOpenIdConnectIssuerUrl: string; \`\`\` -- *Type:* \`string\` +- *Type:* string If this cluster is kubectl-enabled, returns the OpenID Connect issuer url. @@ -84275,49 +86447,49 @@ This is because the values is only be retrieved by the API and not exposed by Cl --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`typescript public readonly clusterSecurityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`typescript public readonly clusterSecurityGroupId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`typescript public readonly connections: Connections; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.Connections\`](#aws-cdk-lib.aws_ec2.Connections) +- *Type:* aws-cdk-lib.aws_ec2.Connections Manages connection rules (Security Group Rules) for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`typescript public readonly openIdConnectProvider: IOpenIdConnectProvider; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) +- *Type:* aws-cdk-lib.aws_iam.IOpenIdConnectProvider An \`OpenIdConnectProvider\` resource associated with this cluster, and which can be used to link this cluster to AWS IAM. @@ -84325,49 +86497,49 @@ A provider will only be defined if this property is accessed (lazy initializatio --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean Determines if Kubernetes resources can be pruned automatically. --- -##### \`role\`Required +##### \`role\`Required \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole IAM role assumed by the EKS Control Plane. --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`typescript public readonly defaultCapacity: AutoScalingGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.AutoScalingGroup\`](#aws-cdk-lib.aws_autoscaling.AutoScalingGroup) +- *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup The auto scaling group that hosts the default capacity for this cluster. @@ -84375,13 +86547,13 @@ This will be \`undefined\` if the \`defaultCapacityType\` is not \`EC2\` or \`de --- -##### \`defaultNodegroup\`Optional +##### \`defaultNodegroup\`Optional \`\`\`typescript public readonly defaultNodegroup: Nodegroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.Nodegroup\`](#aws-cdk-lib.aws_eks.Nodegroup) +- *Type:* Nodegroup The node group that hosts the default capacity for this cluster. @@ -84389,25 +86561,25 @@ This will be \`undefined\` if the \`defaultCapacityType\` is \`EC2\` or \`defaul --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion The AWS Lambda layer that contains \`kubectl\`, \`helm\` and the AWS CLI. @@ -84415,38 +86587,38 @@ If undefined, a SAR app that contains this layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size The amount of memory allocated to the kubectl provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`typescript public readonly kubectlPrivateSubnets: ISubnet[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISubnet\`](#aws-cdk-lib.aws_ec2.ISubnet)[] +- *Type:* aws-cdk-lib.aws_ec2.ISubnet[] - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. Subnets to host the \`kubectl\` compute resources. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`typescript public readonly kubectlRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -84454,13 +86626,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`typescript public readonly kubectlSecurityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* If not specified, the k8s endpoint is expected to be accessible publicly. A security group to use for \`kubectl\` execution. @@ -84468,13 +86640,13 @@ A security group to use for \`kubectl\` execution. --- -### FargateCluster +### FargateCluster Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the \\"default\\" and \\"kube-system\\" namespaces. You can add additional profiles using \`addFargateProfile\`. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84484,27 +86656,27 @@ new aws_eks.FargateCluster(scope: Construct, id: string, props: FargateClusterPr | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksfargateclusterparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawseksfargateclusterparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawseksfargateclusterparameterprops)* | [\`aws-cdk-lib.aws_eks.FargateClusterProps\`](#aws-cdk-lib.aws_eks.FargateClusterProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | FargateClusterProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.FargateClusterProps\`](#aws-cdk-lib.aws_eks.FargateClusterProps) +- *Type:* FargateClusterProps --- @@ -84512,15 +86684,15 @@ new aws_eks.FargateCluster(scope: Construct, id: string, props: FargateClusterPr -### FargateProfile +### FargateProfile -- *Implements:* [\`aws-cdk-lib.ITaggable\`](#aws-cdk-lib.ITaggable) +- *Implements:* aws-cdk-lib.ITaggable Fargate profiles allows an administrator to declare which pods run on Fargate. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate. If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84530,74 +86702,74 @@ new aws_eks.FargateProfile(scope: Construct, id: string, props: FargateProfilePr | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksfargateprofileparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawseksfargateprofileparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawseksfargateprofileparameterprops)* | [\`aws-cdk-lib.aws_eks.FargateProfileProps\`](#aws-cdk-lib.aws_eks.FargateProfileProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | FargateProfileProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.FargateProfileProps\`](#aws-cdk-lib.aws_eks.FargateProfileProps) +- *Type:* FargateProfileProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`fargateProfileArn\`](#awscdklibawseksfargateprofilepropertyfargateprofilearn)* | \`string\` | The full Amazon Resource Name (ARN) of the Fargate profile. | -| [\`fargateProfileName\`](#awscdklibawseksfargateprofilepropertyfargateprofilename)* | \`string\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#awscdklibawseksfargateprofilepropertypodexecutionrole)* | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`tags\`](#awscdklibawseksfargateprofilepropertytags)* | [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) | Resource tags. | +| fargateProfileArn | string | The full Amazon Resource Name (ARN) of the Fargate profile. | +| fargateProfileName | string | The name of the Fargate profile. | +| podExecutionRole | aws-cdk-lib.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| tags | aws-cdk-lib.TagManager | Resource tags. | --- -##### \`fargateProfileArn\`Required +##### \`fargateProfileArn\`Required \`\`\`typescript public readonly fargateProfileArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The full Amazon Resource Name (ARN) of the Fargate profile. --- -##### \`fargateProfileName\`Required +##### \`fargateProfileName\`Required \`\`\`typescript public readonly fargateProfileName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the Fargate profile. --- -##### \`podExecutionRole\`Required +##### \`podExecutionRole\`Required \`\`\`typescript public readonly podExecutionRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole The pod execution role to use for pods that match the selectors in the Fargate profile. @@ -84605,26 +86777,26 @@ The pod execution role allows Fargate infrastructure to register with your clust --- -##### \`tags\`Required +##### \`tags\`Required \`\`\`typescript public readonly tags: TagManager; \`\`\` -- *Type:* [\`aws-cdk-lib.TagManager\`](#aws-cdk-lib.TagManager) +- *Type:* aws-cdk-lib.TagManager Resource tags. --- -### HelmChart +### HelmChart Represents a helm chart within the Kubernetes system. Applies/deletes the resources using \`kubectl\` in sync with the resource. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84634,56 +86806,60 @@ new aws_eks.HelmChart(scope: Construct, id: string, props: HelmChartProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekshelmchartparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawsekshelmchartparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawsekshelmchartparameterprops)* | [\`aws-cdk-lib.aws_eks.HelmChartProps\`](#aws-cdk-lib.aws_eks.HelmChartProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | HelmChartProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.HelmChartProps\`](#aws-cdk-lib.aws_eks.HelmChartProps) +- *Type:* HelmChartProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdklibawsekshelmchartpropertyresourcetype)* | \`string\` | The CloudFormation resource type. | +| RESOURCE_TYPE | string | The CloudFormation resource type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly RESOURCE_TYPE: string; +\`\`\` + +- *Type:* string The CloudFormation resource type. --- -### KubernetesManifest +### KubernetesManifest Represents a manifest within the Kubernetes system. Alternatively, you can use \`cluster.addManifest(resource[, resource, ...])\` to define resources on this cluster. Applies/deletes the manifest using \`kubectl\`. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84693,56 +86869,60 @@ new aws_eks.KubernetesManifest(scope: Construct, id: string, props: KubernetesMa | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekskubernetesmanifestparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawsekskubernetesmanifestparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawsekskubernetesmanifestparameterprops)* | [\`aws-cdk-lib.aws_eks.KubernetesManifestProps\`](#aws-cdk-lib.aws_eks.KubernetesManifestProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | KubernetesManifestProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesManifestProps\`](#aws-cdk-lib.aws_eks.KubernetesManifestProps) +- *Type:* KubernetesManifestProps --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdklibawsekskubernetesmanifestpropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | string | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required -- *Type:* \`string\` +\`\`\`typescript +public readonly RESOURCE_TYPE: string; +\`\`\` + +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesObjectValue +### KubernetesObjectValue Represents a value of a specific object deployed in the cluster. Use this to fetch any information available by the \`kubectl get\` command. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84752,75 +86932,79 @@ new aws_eks.KubernetesObjectValue(scope: Construct, id: string, props: Kubernete | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekskubernetesobjectvalueparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawsekskubernetesobjectvalueparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawsekskubernetesobjectvalueparameterprops)* | [\`aws-cdk-lib.aws_eks.KubernetesObjectValueProps\`](#aws-cdk-lib.aws_eks.KubernetesObjectValueProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | KubernetesObjectValueProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesObjectValueProps\`](#aws-cdk-lib.aws_eks.KubernetesObjectValueProps) +- *Type:* KubernetesObjectValueProps --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`value\`](#awscdklibawsekskubernetesobjectvaluepropertyvalue)* | \`string\` | The value as a string token. | +| value | string | The value as a string token. | --- -##### \`value\`Required +##### \`value\`Required \`\`\`typescript public readonly value: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The value as a string token. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RESOURCE_TYPE\`](#awscdklibawsekskubernetesobjectvaluepropertyresourcetype)* | \`string\` | The CloudFormation reosurce type. | +| RESOURCE_TYPE | string | The CloudFormation reosurce type. | --- -##### \`RESOURCE_TYPE\` +##### \`RESOURCE_TYPE\`Required + +\`\`\`typescript +public readonly RESOURCE_TYPE: string; +\`\`\` -- *Type:* \`string\` +- *Type:* string The CloudFormation reosurce type. --- -### KubernetesPatch +### KubernetesPatch A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource. -> https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/ +> [https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/](https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84830,27 +87014,27 @@ new aws_eks.KubernetesPatch(scope: Construct, id: string, props: KubernetesPatch | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawsekskubernetespatchparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawsekskubernetespatchparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawsekskubernetespatchparameterprops)* | [\`aws-cdk-lib.aws_eks.KubernetesPatchProps\`](#aws-cdk-lib.aws_eks.KubernetesPatchProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | KubernetesPatchProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesPatchProps\`](#aws-cdk-lib.aws_eks.KubernetesPatchProps) +- *Type:* KubernetesPatchProps --- @@ -84858,13 +87042,13 @@ new aws_eks.KubernetesPatch(scope: Construct, id: string, props: KubernetesPatch -### Nodegroup +### Nodegroup -- *Implements:* [\`aws-cdk-lib.aws_eks.INodegroup\`](#aws-cdk-lib.aws_eks.INodegroup) +- *Implements:* INodegroup The Nodegroup resource class. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84874,40 +87058,40 @@ new aws_eks.Nodegroup(scope: Construct, id: string, props: NodegroupProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksnodegroupparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawseksnodegroupparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawseksnodegroupparameterprops)* | [\`aws-cdk-lib.aws_eks.NodegroupProps\`](#aws-cdk-lib.aws_eks.NodegroupProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | NodegroupProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupProps\`](#aws-cdk-lib.aws_eks.NodegroupProps) +- *Type:* NodegroupProps --- -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`fromNodegroupName\`](#awscdklibawseksnodegroupfromnodegroupname) | Import the Nodegroup from attributes. | +| fromNodegroupName | Import the Nodegroup from attributes. | --- -##### \`fromNodegroupName\` +##### \`fromNodegroupName\` \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -84915,93 +87099,93 @@ import { aws_eks } from 'aws-cdk-lib' aws_eks.Nodegroup.fromNodegroupName(scope: Construct, id: string, nodegroupName: string) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -###### \`nodegroupName\`Required +###### \`nodegroupName\`Required -- *Type:* \`string\` +- *Type:* string --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdklibawseksnodegrouppropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | the Amazon EKS cluster resource. | -| [\`nodegroupArn\`](#awscdklibawseksnodegrouppropertynodegrouparn)* | \`string\` | ARN of the nodegroup. | -| [\`nodegroupName\`](#awscdklibawseksnodegrouppropertynodegroupname)* | \`string\` | Nodegroup name. | -| [\`role\`](#awscdklibawseksnodegrouppropertyrole)* | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | IAM role of the instance profile for the nodegroup. | +| cluster | ICluster | the Amazon EKS cluster resource. | +| nodegroupArn | string | ARN of the nodegroup. | +| nodegroupName | string | Nodegroup name. | +| role | aws-cdk-lib.aws_iam.IRole | IAM role of the instance profile for the nodegroup. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster the Amazon EKS cluster resource. --- -##### \`nodegroupArn\`Required +##### \`nodegroupArn\`Required \`\`\`typescript public readonly nodegroupArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string ARN of the nodegroup. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string Nodegroup name. --- -##### \`role\`Required +##### \`role\`Required \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole IAM role of the instance profile for the nodegroup. --- -### OpenIdConnectProvider +### OpenIdConnectProvider IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce. You use an IAM OIDC identity provider when you want to establish trust between an OIDC-compatible IdP and your AWS account. This implementation has default values for thumbprints and clientIds props that will be compatible with the eks cluster -> https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html +> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85011,31 +87195,31 @@ new aws_eks.OpenIdConnectProvider(scope: Construct, id: string, props: OpenIdCon | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksopenidconnectproviderparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | The definition scope. | -| [\`id\`](#awscdklibawseksopenidconnectproviderparameterid)* | \`string\` | Construct ID. | -| [\`props\`](#awscdklibawseksopenidconnectproviderparameterprops)* | [\`aws-cdk-lib.aws_eks.OpenIdConnectProviderProps\`](#aws-cdk-lib.aws_eks.OpenIdConnectProviderProps) | Initialization properties. | +| scope | constructs.Construct | The definition scope. | +| id | string | Construct ID. | +| props | OpenIdConnectProviderProps | Initialization properties. | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct The definition scope. --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string Construct ID. --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.OpenIdConnectProviderProps\`](#aws-cdk-lib.aws_eks.OpenIdConnectProviderProps) +- *Type:* OpenIdConnectProviderProps Initialization properties. @@ -85045,13 +87229,13 @@ Initialization properties. -### ServiceAccount +### ServiceAccount -- *Implements:* [\`aws-cdk-lib.aws_iam.IPrincipal\`](#aws-cdk-lib.aws_iam.IPrincipal) +- *Implements:* aws-cdk-lib.aws_iam.IPrincipal Service Account. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85061,144 +87245,144 @@ new aws_eks.ServiceAccount(scope: Construct, id: string, props: ServiceAccountPr | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdklibawseksserviceaccountparameterscope)* | [\`constructs.Construct\`](#constructs.Construct) | *No description.* | -| [\`id\`](#awscdklibawseksserviceaccountparameterid)* | \`string\` | *No description.* | -| [\`props\`](#awscdklibawseksserviceaccountparameterprops)* | [\`aws-cdk-lib.aws_eks.ServiceAccountProps\`](#aws-cdk-lib.aws_eks.ServiceAccountProps) | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | ServiceAccountProps | *No description.* | --- -##### \`scope\`Required +##### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -##### \`id\`Required +##### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -##### \`props\`Required +##### \`props\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.ServiceAccountProps\`](#aws-cdk-lib.aws_eks.ServiceAccountProps) +- *Type:* ServiceAccountProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addToPrincipalPolicy\`](#awscdklibawseksserviceaccountaddtoprincipalpolicy) | Add to the policy of this principal. | +| addToPrincipalPolicy | Add to the policy of this principal. | --- -##### \`addToPrincipalPolicy\` +##### \`addToPrincipalPolicy\` \`\`\`typescript public addToPrincipalPolicy(statement: PolicyStatement) \`\`\` -###### \`statement\`Required +###### \`statement\`Required -- *Type:* [\`aws-cdk-lib.aws_iam.PolicyStatement\`](#aws-cdk-lib.aws_iam.PolicyStatement) +- *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`assumeRoleAction\`](#awscdklibawseksserviceaccountpropertyassumeroleaction)* | \`string\` | When this Principal is used in an AssumeRole policy, the action to use. | -| [\`grantPrincipal\`](#awscdklibawseksserviceaccountpropertygrantprincipal)* | [\`aws-cdk-lib.aws_iam.IPrincipal\`](#aws-cdk-lib.aws_iam.IPrincipal) | The principal to grant permissions to. | -| [\`policyFragment\`](#awscdklibawseksserviceaccountpropertypolicyfragment)* | [\`aws-cdk-lib.aws_iam.PrincipalPolicyFragment\`](#aws-cdk-lib.aws_iam.PrincipalPolicyFragment) | Return the policy fragment that identifies this principal in a Policy. | -| [\`role\`](#awscdklibawseksserviceaccountpropertyrole)* | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The role which is linked to the service account. | -| [\`serviceAccountName\`](#awscdklibawseksserviceaccountpropertyserviceaccountname)* | \`string\` | The name of the service account. | -| [\`serviceAccountNamespace\`](#awscdklibawseksserviceaccountpropertyserviceaccountnamespace)* | \`string\` | The namespace where the service account is located in. | +| assumeRoleAction | string | When this Principal is used in an AssumeRole policy, the action to use. | +| grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal to grant permissions to. | +| policyFragment | aws-cdk-lib.aws_iam.PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. | +| role | aws-cdk-lib.aws_iam.IRole | The role which is linked to the service account. | +| serviceAccountName | string | The name of the service account. | +| serviceAccountNamespace | string | The namespace where the service account is located in. | --- -##### \`assumeRoleAction\`Required +##### \`assumeRoleAction\`Required \`\`\`typescript public readonly assumeRoleAction: string; \`\`\` -- *Type:* \`string\` +- *Type:* string When this Principal is used in an AssumeRole policy, the action to use. --- -##### \`grantPrincipal\`Required +##### \`grantPrincipal\`Required \`\`\`typescript public readonly grantPrincipal: IPrincipal; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IPrincipal\`](#aws-cdk-lib.aws_iam.IPrincipal) +- *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to. --- -##### \`policyFragment\`Required +##### \`policyFragment\`Required \`\`\`typescript public readonly policyFragment: PrincipalPolicyFragment; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.PrincipalPolicyFragment\`](#aws-cdk-lib.aws_iam.PrincipalPolicyFragment) +- *Type:* aws-cdk-lib.aws_iam.PrincipalPolicyFragment Return the policy fragment that identifies this principal in a Policy. --- -##### \`role\`Required +##### \`role\`Required \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole The role which is linked to the service account. --- -##### \`serviceAccountName\`Required +##### \`serviceAccountName\`Required \`\`\`typescript public readonly serviceAccountName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the service account. --- -##### \`serviceAccountNamespace\`Required +##### \`serviceAccountNamespace\`Required \`\`\`typescript public readonly serviceAccountNamespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The namespace where the service account is located in. --- -## Structs +## Structs -### AutoScalingGroupCapacityOptions +### AutoScalingGroupCapacityOptions Options for adding worker nodes. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85206,72 +87390,72 @@ import { aws_eks } from 'aws-cdk-lib' const autoScalingGroupCapacityOptions: aws_eks.AutoScalingGroupCapacityOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`allowAllOutbound\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyallowalloutbound) | \`boolean\` | Whether the instances can initiate connections to anywhere by default. | -| [\`associatePublicIpAddress\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyassociatepublicipaddress) | \`boolean\` | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | -| [\`autoScalingGroupName\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyautoscalinggroupname) | \`string\` | The name of the Auto Scaling group. | -| [\`blockDevices\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyblockdevices) | [\`aws-cdk-lib.aws_autoscaling.BlockDevice\`](#aws-cdk-lib.aws_autoscaling.BlockDevice)[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | -| [\`cooldown\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertycooldown) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | Default scaling cooldown for this AutoScalingGroup. | -| [\`desiredCapacity\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertydesiredcapacity) | \`number\` | Initial amount of instances in the fleet. | -| [\`groupMetrics\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertygroupmetrics) | [\`aws-cdk-lib.aws_autoscaling.GroupMetrics\`](#aws-cdk-lib.aws_autoscaling.GroupMetrics)[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | -| [\`healthCheck\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyhealthcheck) | [\`aws-cdk-lib.aws_autoscaling.HealthCheck\`](#aws-cdk-lib.aws_autoscaling.HealthCheck) | Configuration for health checks. | -| [\`ignoreUnmodifiedSizeProperties\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyignoreunmodifiedsizeproperties) | \`boolean\` | If the ASG has scheduled actions, don't reset unchanged group sizes. | -| [\`instanceMonitoring\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyinstancemonitoring) | [\`aws-cdk-lib.aws_autoscaling.Monitoring\`](#aws-cdk-lib.aws_autoscaling.Monitoring) | Controls whether instances in this group are launched with detailed or basic monitoring. | -| [\`keyName\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertykeyname) | \`string\` | Name of SSH keypair to grant access to instances. | -| [\`maxCapacity\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertymaxcapacity) | \`number\` | Maximum number of instances in the fleet. | -| [\`maxInstanceLifetime\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertymaxinstancelifetime) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | The maximum amount of time that an instance can be in service. | -| [\`minCapacity\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertymincapacity) | \`number\` | Minimum number of instances in the fleet. | -| [\`newInstancesProtectedFromScaleIn\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertynewinstancesprotectedfromscalein) | \`boolean\` | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | -| [\`notifications\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertynotifications) | [\`aws-cdk-lib.aws_autoscaling.NotificationConfiguration\`](#aws-cdk-lib.aws_autoscaling.NotificationConfiguration)[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | -| [\`signals\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertysignals) | [\`aws-cdk-lib.aws_autoscaling.Signals\`](#aws-cdk-lib.aws_autoscaling.Signals) | Configure waiting for signals during deployment. | -| [\`spotPrice\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyspotprice) | \`string\` | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | -| [\`updatePolicy\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyupdatepolicy) | [\`aws-cdk-lib.aws_autoscaling.UpdatePolicy\`](#aws-cdk-lib.aws_autoscaling.UpdatePolicy) | What to do when an AutoScalingGroup's instance configuration is changed. | -| [\`vpcSubnets\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyvpcsubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) | Where to place instances within the VPC. | -| [\`instanceType\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyinstancetype)* | [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType) | Instance type of the instances to start. | -| [\`bootstrapEnabled\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertybootstrapenabled) | \`boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertybootstrapoptions) | [\`aws-cdk-lib.aws_eks.BootstrapOptions\`](#aws-cdk-lib.aws_eks.BootstrapOptions) | EKS node bootstrapping options. | -| [\`machineImageType\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertymachineimagetype) | [\`aws-cdk-lib.aws_eks.MachineImageType\`](#aws-cdk-lib.aws_eks.MachineImageType) | Machine image type. | -| [\`mapRole\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertymaprole) | \`boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#awscdklibawseksautoscalinggroupcapacityoptionspropertyspotinterrupthandler) | \`boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| allowAllOutbound | boolean | Whether the instances can initiate connections to anywhere by default. | +| associatePublicIpAddress | boolean | Whether instances in the Auto Scaling Group should have public IP addresses associated with them. | +| autoScalingGroupName | string | The name of the Auto Scaling group. | +| blockDevices | aws-cdk-lib.aws_autoscaling.BlockDevice[] | Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. | +| cooldown | aws-cdk-lib.Duration | Default scaling cooldown for this AutoScalingGroup. | +| desiredCapacity | number | Initial amount of instances in the fleet. | +| groupMetrics | aws-cdk-lib.aws_autoscaling.GroupMetrics[] | Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. | +| healthCheck | aws-cdk-lib.aws_autoscaling.HealthCheck | Configuration for health checks. | +| ignoreUnmodifiedSizeProperties | boolean | If the ASG has scheduled actions, don't reset unchanged group sizes. | +| instanceMonitoring | aws-cdk-lib.aws_autoscaling.Monitoring | Controls whether instances in this group are launched with detailed or basic monitoring. | +| keyName | string | Name of SSH keypair to grant access to instances. | +| maxCapacity | number | Maximum number of instances in the fleet. | +| maxInstanceLifetime | aws-cdk-lib.Duration | The maximum amount of time that an instance can be in service. | +| minCapacity | number | Minimum number of instances in the fleet. | +| newInstancesProtectedFromScaleIn | boolean | Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. | +| notifications | aws-cdk-lib.aws_autoscaling.NotificationConfiguration[] | Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). | +| signals | aws-cdk-lib.aws_autoscaling.Signals | Configure waiting for signals during deployment. | +| spotPrice | string | The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. | +| updatePolicy | aws-cdk-lib.aws_autoscaling.UpdatePolicy | What to do when an AutoScalingGroup's instance configuration is changed. | +| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place instances within the VPC. | +| instanceType | aws-cdk-lib.aws_ec2.InstanceType | Instance type of the instances to start. | +| bootstrapEnabled | boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | BootstrapOptions | EKS node bootstrapping options. | +| machineImageType | MachineImageType | Machine image type. | +| mapRole | boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`allowAllOutbound\`Optional +##### \`allowAllOutbound\`Optional \`\`\`typescript public readonly allowAllOutbound: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Whether the instances can initiate connections to anywhere by default. --- -##### \`associatePublicIpAddress\`Optional +##### \`associatePublicIpAddress\`Optional \`\`\`typescript public readonly associatePublicIpAddress: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* Use subnet setting. Whether instances in the Auto Scaling Group should have public IP addresses associated with them. --- -##### \`autoScalingGroupName\`Optional +##### \`autoScalingGroupName\`Optional \`\`\`typescript public readonly autoScalingGroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Auto generated by CloudFormation The name of the Auto Scaling group. @@ -85280,60 +87464,60 @@ This name must be unique per Region per account. --- -##### \`blockDevices\`Optional +##### \`blockDevices\`Optional \`\`\`typescript public readonly blockDevices: BlockDevice[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.BlockDevice\`](#aws-cdk-lib.aws_autoscaling.BlockDevice)[] +- *Type:* aws-cdk-lib.aws_autoscaling.BlockDevice[] - *Default:* Uses the block device mapping of the AMI Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched. -> https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html +> [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) --- -##### \`cooldown\`Optional +##### \`cooldown\`Optional \`\`\`typescript public readonly cooldown: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) Default scaling cooldown for this AutoScalingGroup. --- -##### \`desiredCapacity\`Optional +##### \`desiredCapacity\`Optional \`\`\`typescript public readonly desiredCapacity: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* minCapacity, and leave unchanged during deployment Initial amount of instances in the fleet. If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity) --- -##### \`groupMetrics\`Optional +##### \`groupMetrics\`Optional \`\`\`typescript public readonly groupMetrics: GroupMetrics[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.GroupMetrics\`](#aws-cdk-lib.aws_autoscaling.GroupMetrics)[] +- *Type:* aws-cdk-lib.aws_autoscaling.GroupMetrics[] - *Default:* no group metrics will be reported Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. @@ -85342,26 +87526,26 @@ To report all group metrics use \`GroupMetrics.all()\` Group metrics are reporte --- -##### \`healthCheck\`Optional +##### \`healthCheck\`Optional \`\`\`typescript public readonly healthCheck: HealthCheck; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.HealthCheck\`](#aws-cdk-lib.aws_autoscaling.HealthCheck) +- *Type:* aws-cdk-lib.aws_autoscaling.HealthCheck - *Default:* HealthCheck.ec2 with no grace period Configuration for health checks. --- -##### \`ignoreUnmodifiedSizeProperties\`Optional +##### \`ignoreUnmodifiedSizeProperties\`Optional \`\`\`typescript public readonly ignoreUnmodifiedSizeProperties: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true If the ASG has scheduled actions, don't reset unchanged group sizes. @@ -85370,86 +87554,86 @@ Only used if the ASG has scheduled actions (which may scale your ASG up or down --- -##### \`instanceMonitoring\`Optional +##### \`instanceMonitoring\`Optional \`\`\`typescript public readonly instanceMonitoring: Monitoring; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.Monitoring\`](#aws-cdk-lib.aws_autoscaling.Monitoring) +- *Type:* aws-cdk-lib.aws_autoscaling.Monitoring - *Default:* Monitoring.DETAILED Controls whether instances in this group are launched with detailed or basic monitoring. When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. -> https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics +> [https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics](https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics) --- -##### \`keyName\`Optional +##### \`keyName\`Optional \`\`\`typescript public readonly keyName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No SSH access will be possible. Name of SSH keypair to grant access to instances. --- -##### \`maxCapacity\`Optional +##### \`maxCapacity\`Optional \`\`\`typescript public readonly maxCapacity: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* desiredCapacity Maximum number of instances in the fleet. --- -##### \`maxInstanceLifetime\`Optional +##### \`maxInstanceLifetime\`Optional \`\`\`typescript public readonly maxInstanceLifetime: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* none The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again. You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined. -> https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html +> [https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) --- -##### \`minCapacity\`Optional +##### \`minCapacity\`Optional \`\`\`typescript public readonly minCapacity: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 1 Minimum number of instances in the fleet. --- -##### \`newInstancesProtectedFromScaleIn\`Optional +##### \`newInstancesProtectedFromScaleIn\`Optional \`\`\`typescript public readonly newInstancesProtectedFromScaleIn: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. @@ -85458,28 +87642,28 @@ By default, Auto Scaling can terminate an instance at any time after launch when --- -##### \`notifications\`Optional +##### \`notifications\`Optional \`\`\`typescript public readonly notifications: NotificationConfiguration[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.NotificationConfiguration\`](#aws-cdk-lib.aws_autoscaling.NotificationConfiguration)[] +- *Type:* aws-cdk-lib.aws_autoscaling.NotificationConfiguration[] - *Default:* No fleet change notifications will be sent. Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations) --- -##### \`signals\`Optional +##### \`signals\`Optional \`\`\`typescript public readonly signals: Signals; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.Signals\`](#aws-cdk-lib.aws_autoscaling.Signals) +- *Type:* aws-cdk-lib.aws_autoscaling.Signals - *Default:* Do not wait for signals Configure waiting for signals during deployment. @@ -85488,13 +87672,13 @@ Use this to pause the CloudFormation deployment to wait for the instances in the --- -##### \`spotPrice\`Optional +##### \`spotPrice\`Optional \`\`\`typescript public readonly spotPrice: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. @@ -85503,13 +87687,13 @@ Spot Instances are launched when the price you specify exceeds the current Spot --- -##### \`updatePolicy\`Optional +##### \`updatePolicy\`Optional \`\`\`typescript public readonly updatePolicy: UpdatePolicy; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_autoscaling.UpdatePolicy\`](#aws-cdk-lib.aws_autoscaling.UpdatePolicy) +- *Type:* aws-cdk-lib.aws_autoscaling.UpdatePolicy - *Default:* \`UpdatePolicy.rollingUpdate()\` if using \`init\`, \`UpdatePolicy.none()\` otherwise What to do when an AutoScalingGroup's instance configuration is changed. @@ -85518,38 +87702,38 @@ This is applied when any of the settings on the ASG are changed that affect how --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`typescript public readonly vpcSubnets: SubnetSelection; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* All Private subnets. Where to place instances within the VPC. --- -##### \`instanceType\`Required +##### \`instanceType\`Required \`\`\`typescript public readonly instanceType: InstanceType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType) +- *Type:* aws-cdk-lib.aws_ec2.InstanceType Instance type of the instances to start. --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`typescript public readonly bootstrapEnabled: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -85558,39 +87742,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`typescript public readonly bootstrapOptions: BootstrapOptions; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.BootstrapOptions\`](#aws-cdk-lib.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* none EKS node bootstrapping options. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`typescript public readonly machineImageType: MachineImageType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.MachineImageType\`](#aws-cdk-lib.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`typescript public readonly mapRole: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -85599,13 +87783,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`typescript public readonly spotInterruptHandler: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -85614,11 +87798,11 @@ Only relevant if \`spotPrice\` is used. --- -### AutoScalingGroupOptions +### AutoScalingGroupOptions Options for adding an AutoScalingGroup as capacity. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85626,25 +87810,25 @@ import { aws_eks } from 'aws-cdk-lib' const autoScalingGroupOptions: aws_eks.AutoScalingGroupOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`bootstrapEnabled\`](#awscdklibawseksautoscalinggroupoptionspropertybootstrapenabled) | \`boolean\` | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | -| [\`bootstrapOptions\`](#awscdklibawseksautoscalinggroupoptionspropertybootstrapoptions) | [\`aws-cdk-lib.aws_eks.BootstrapOptions\`](#aws-cdk-lib.aws_eks.BootstrapOptions) | Allows options for node bootstrapping through EC2 user data. | -| [\`machineImageType\`](#awscdklibawseksautoscalinggroupoptionspropertymachineimagetype) | [\`aws-cdk-lib.aws_eks.MachineImageType\`](#aws-cdk-lib.aws_eks.MachineImageType) | Allow options to specify different machine image type. | -| [\`mapRole\`](#awscdklibawseksautoscalinggroupoptionspropertymaprole) | \`boolean\` | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | -| [\`spotInterruptHandler\`](#awscdklibawseksautoscalinggroupoptionspropertyspotinterrupthandler) | \`boolean\` | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | +| bootstrapEnabled | boolean | Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. | +| bootstrapOptions | BootstrapOptions | Allows options for node bootstrapping through EC2 user data. | +| machineImageType | MachineImageType | Allow options to specify different machine image type. | +| mapRole | boolean | Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. | +| spotInterruptHandler | boolean | Installs the AWS spot instance interrupt handler on the cluster if it's not already added. | --- -##### \`bootstrapEnabled\`Optional +##### \`bootstrapEnabled\`Optional \`\`\`typescript public readonly bootstrapEnabled: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke \`/etc/eks/bootstrap.sh\`) and associate it with the EKS cluster. @@ -85653,39 +87837,39 @@ If you wish to provide a custom user data script, set this to \`false\` and manu --- -##### \`bootstrapOptions\`Optional +##### \`bootstrapOptions\`Optional \`\`\`typescript public readonly bootstrapOptions: BootstrapOptions; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.BootstrapOptions\`](#aws-cdk-lib.aws_eks.BootstrapOptions) +- *Type:* BootstrapOptions - *Default:* default options Allows options for node bootstrapping through EC2 user data. --- -##### \`machineImageType\`Optional +##### \`machineImageType\`Optional \`\`\`typescript public readonly machineImageType: MachineImageType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.MachineImageType\`](#aws-cdk-lib.aws_eks.MachineImageType) +- *Type:* MachineImageType - *Default:* MachineImageType.AMAZON_LINUX_2 Allow options to specify different machine image type. --- -##### \`mapRole\`Optional +##### \`mapRole\`Optional \`\`\`typescript public readonly mapRole: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true if the cluster has kubectl enabled (which is the default). Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC. @@ -85694,13 +87878,13 @@ This cannot be explicitly set to \`true\` if the cluster has kubectl disabled. --- -##### \`spotInterruptHandler\`Optional +##### \`spotInterruptHandler\`Optional \`\`\`typescript public readonly spotInterruptHandler: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Installs the AWS spot instance interrupt handler on the cluster if it's not already added. @@ -85709,11 +87893,11 @@ Only relevant if \`spotPrice\` is configured on the auto-scaling group. --- -### AwsAuthMapping +### AwsAuthMapping AwsAuth mapping. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85721,47 +87905,47 @@ import { aws_eks } from 'aws-cdk-lib' const awsAuthMapping: aws_eks.AwsAuthMapping = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`groups\`](#awscdklibawseksawsauthmappingpropertygroups)* | \`string\`[] | A list of groups within Kubernetes to which the role is mapped. | -| [\`username\`](#awscdklibawseksawsauthmappingpropertyusername) | \`string\` | The user name within Kubernetes to map to the IAM role. | +| groups | string[] | A list of groups within Kubernetes to which the role is mapped. | +| username | string | The user name within Kubernetes to map to the IAM role. | --- -##### \`groups\`Required +##### \`groups\`Required \`\`\`typescript public readonly groups: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] A list of groups within Kubernetes to which the role is mapped. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`username\`Optional +##### \`username\`Optional \`\`\`typescript public readonly username: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* By default, the user name is the ARN of the IAM role. The user name within Kubernetes to map to the IAM role. --- -### AwsAuthProps +### AwsAuthProps Configuration props for the AwsAuth construct. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85769,21 +87953,21 @@ import { aws_eks } from 'aws-cdk-lib' const awsAuthProps: aws_eks.AwsAuthProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdklibawseksawsauthpropspropertycluster)* | [\`aws-cdk-lib.aws_eks.Cluster\`](#aws-cdk-lib.aws_eks.Cluster) | The EKS cluster to apply this configuration to. | +| cluster | Cluster | The EKS cluster to apply this configuration to. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: Cluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.Cluster\`](#aws-cdk-lib.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply this configuration to. @@ -85791,11 +87975,11 @@ The EKS cluster to apply this configuration to. --- -### BootstrapOptions +### BootstrapOptions EKS node bootstrapping options. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85803,94 +87987,94 @@ import { aws_eks } from 'aws-cdk-lib' const bootstrapOptions: aws_eks.BootstrapOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`additionalArgs\`](#awscdklibawseksbootstrapoptionspropertyadditionalargs) | \`string\` | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | -| [\`awsApiRetryAttempts\`](#awscdklibawseksbootstrapoptionspropertyawsapiretryattempts) | \`number\` | Number of retry attempts for AWS API call (DescribeCluster). | -| [\`dnsClusterIp\`](#awscdklibawseksbootstrapoptionspropertydnsclusterip) | \`string\` | Overrides the IP address to use for DNS queries within the cluster. | -| [\`dockerConfigJson\`](#awscdklibawseksbootstrapoptionspropertydockerconfigjson) | \`string\` | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | -| [\`enableDockerBridge\`](#awscdklibawseksbootstrapoptionspropertyenabledockerbridge) | \`boolean\` | Restores the docker default bridge network. | -| [\`kubeletExtraArgs\`](#awscdklibawseksbootstrapoptionspropertykubeletextraargs) | \`string\` | Extra arguments to add to the kubelet. | -| [\`useMaxPods\`](#awscdklibawseksbootstrapoptionspropertyusemaxpods) | \`boolean\` | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | +| additionalArgs | string | Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. | +| awsApiRetryAttempts | number | Number of retry attempts for AWS API call (DescribeCluster). | +| dnsClusterIp | string | Overrides the IP address to use for DNS queries within the cluster. | +| dockerConfigJson | string | The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. | +| enableDockerBridge | boolean | Restores the docker default bridge network. | +| kubeletExtraArgs | string | Extra arguments to add to the kubelet. | +| useMaxPods | boolean | Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. | --- -##### \`additionalArgs\`Optional +##### \`additionalArgs\`Optional \`\`\`typescript public readonly additionalArgs: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Additional command line arguments to pass to the \`/etc/eks/bootstrap.sh\` command. -> https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh +> [https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh) --- -##### \`awsApiRetryAttempts\`Optional +##### \`awsApiRetryAttempts\`Optional \`\`\`typescript public readonly awsApiRetryAttempts: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 3 Number of retry attempts for AWS API call (DescribeCluster). --- -##### \`dnsClusterIp\`Optional +##### \`dnsClusterIp\`Optional \`\`\`typescript public readonly dnsClusterIp: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface. Overrides the IP address to use for DNS queries within the cluster. --- -##### \`dockerConfigJson\`Optional +##### \`dockerConfigJson\`Optional \`\`\`typescript public readonly dockerConfigJson: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none The contents of the \`/etc/docker/daemon.json\` file. Useful if you want a custom config differing from the default one in the EKS AMI. --- -##### \`enableDockerBridge\`Optional +##### \`enableDockerBridge\`Optional \`\`\`typescript public readonly enableDockerBridge: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Restores the docker default bridge network. --- -##### \`kubeletExtraArgs\`Optional +##### \`kubeletExtraArgs\`Optional \`\`\`typescript public readonly kubeletExtraArgs: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* none Extra arguments to add to the kubelet. @@ -85899,26 +88083,26 @@ Useful for adding labels or taints. --- -##### \`useMaxPods\`Optional +##### \`useMaxPods\`Optional \`\`\`typescript public readonly useMaxPods: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Sets \`--max-pods\` for the kubelet based on the capacity of the EC2 instance. --- -### CfnAddonProps +### CfnAddonProps Properties for defining a \`AWS::EKS::Addon\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -85926,26 +88110,26 @@ import { aws_eks } from 'aws-cdk-lib' const cfnAddonProps: aws_eks.CfnAddonProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`addonName\`](#awscdklibawsekscfnaddonpropspropertyaddonname)* | \`string\` | \`AWS::EKS::Addon.AddonName\`. | -| [\`clusterName\`](#awscdklibawsekscfnaddonpropspropertyclustername)* | \`string\` | \`AWS::EKS::Addon.ClusterName\`. | -| [\`addonVersion\`](#awscdklibawsekscfnaddonpropspropertyaddonversion) | \`string\` | \`AWS::EKS::Addon.AddonVersion\`. | -| [\`resolveConflicts\`](#awscdklibawsekscfnaddonpropspropertyresolveconflicts) | \`string\` | \`AWS::EKS::Addon.ResolveConflicts\`. | -| [\`serviceAccountRoleArn\`](#awscdklibawsekscfnaddonpropspropertyserviceaccountrolearn) | \`string\` | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | -| [\`tags\`](#awscdklibawsekscfnaddonpropspropertytags) | [\`aws-cdk-lib.CfnTag\`](#aws-cdk-lib.CfnTag)[] | \`AWS::EKS::Addon.Tags\`. | +| addonName | string | \`AWS::EKS::Addon.AddonName\`. | +| clusterName | string | \`AWS::EKS::Addon.ClusterName\`. | +| addonVersion | string | \`AWS::EKS::Addon.AddonVersion\`. | +| resolveConflicts | string | \`AWS::EKS::Addon.ResolveConflicts\`. | +| serviceAccountRoleArn | string | \`AWS::EKS::Addon.ServiceAccountRoleArn\`. | +| tags | aws-cdk-lib.CfnTag[] | \`AWS::EKS::Addon.Tags\`. | --- -##### \`addonName\`Required +##### \`addonName\`Required \`\`\`typescript public readonly addonName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonName\`. @@ -85953,13 +88137,13 @@ public readonly addonName: string; --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ClusterName\`. @@ -85967,13 +88151,13 @@ public readonly clusterName: string; --- -##### \`addonVersion\`Optional +##### \`addonVersion\`Optional \`\`\`typescript public readonly addonVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.AddonVersion\`. @@ -85981,13 +88165,13 @@ public readonly addonVersion: string; --- -##### \`resolveConflicts\`Optional +##### \`resolveConflicts\`Optional \`\`\`typescript public readonly resolveConflicts: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ResolveConflicts\`. @@ -85995,13 +88179,13 @@ public readonly resolveConflicts: string; --- -##### \`serviceAccountRoleArn\`Optional +##### \`serviceAccountRoleArn\`Optional \`\`\`typescript public readonly serviceAccountRoleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Addon.ServiceAccountRoleArn\`. @@ -86009,13 +88193,13 @@ public readonly serviceAccountRoleArn: string; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`aws-cdk-lib.CfnTag\`](#aws-cdk-lib.CfnTag)[] +- *Type:* aws-cdk-lib.CfnTag[] \`AWS::EKS::Addon.Tags\`. @@ -86023,13 +88207,13 @@ public readonly tags: CfnTag[]; --- -### CfnClusterProps +### CfnClusterProps Properties for defining a \`AWS::EKS::Cluster\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -86037,26 +88221,26 @@ import { aws_eks } from 'aws-cdk-lib' const cfnClusterProps: aws_eks.CfnClusterProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`resourcesVpcConfig\`](#awscdklibawsekscfnclusterpropspropertyresourcesvpcconfig)* | [\`aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | -| [\`roleArn\`](#awscdklibawsekscfnclusterpropspropertyrolearn)* | \`string\` | \`AWS::EKS::Cluster.RoleArn\`. | -| [\`encryptionConfig\`](#awscdklibawsekscfnclusterpropspropertyencryptionconfig) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::Cluster.EncryptionConfig\`. | -| [\`kubernetesNetworkConfig\`](#awscdklibawsekscfnclusterpropspropertykubernetesnetworkconfig) | [\`aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | -| [\`name\`](#awscdklibawsekscfnclusterpropspropertyname) | \`string\` | \`AWS::EKS::Cluster.Name\`. | -| [\`version\`](#awscdklibawsekscfnclusterpropspropertyversion) | \`string\` | \`AWS::EKS::Cluster.Version\`. | +| resourcesVpcConfig | ResourcesVpcConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Cluster.ResourcesVpcConfig\`. | +| roleArn | string | \`AWS::EKS::Cluster.RoleArn\`. | +| encryptionConfig | aws-cdk-lib.IResolvable \\\\| EncryptionConfigProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::Cluster.EncryptionConfig\`. | +| kubernetesNetworkConfig | KubernetesNetworkConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. | +| name | string | \`AWS::EKS::Cluster.Name\`. | +| version | string | \`AWS::EKS::Cluster.Version\`. | --- -##### \`resourcesVpcConfig\`Required +##### \`resourcesVpcConfig\`Required \`\`\`typescript public readonly resourcesVpcConfig: ResourcesVpcConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* ResourcesVpcConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Cluster.ResourcesVpcConfig\`. @@ -86064,13 +88248,13 @@ public readonly resourcesVpcConfig: ResourcesVpcConfigProperty | IResolvable; --- -##### \`roleArn\`Required +##### \`roleArn\`Required \`\`\`typescript public readonly roleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.RoleArn\`. @@ -86078,13 +88262,13 @@ public readonly roleArn: string; --- -##### \`encryptionConfig\`Optional +##### \`encryptionConfig\`Optional \`\`\`typescript public readonly encryptionConfig: IResolvable | EncryptionConfigProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | EncryptionConfigProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::Cluster.EncryptionConfig\`. @@ -86092,13 +88276,13 @@ public readonly encryptionConfig: IResolvable | EncryptionConfigProperty | IReso --- -##### \`kubernetesNetworkConfig\`Optional +##### \`kubernetesNetworkConfig\`Optional \`\`\`typescript public readonly kubernetesNetworkConfig: KubernetesNetworkConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* KubernetesNetworkConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Cluster.KubernetesNetworkConfig\`. @@ -86106,13 +88290,13 @@ public readonly kubernetesNetworkConfig: KubernetesNetworkConfigProperty | IReso --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`typescript public readonly name: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Name\`. @@ -86120,13 +88304,13 @@ public readonly name: string; --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Cluster.Version\`. @@ -86134,13 +88318,13 @@ public readonly version: string; --- -### CfnFargateProfileProps +### CfnFargateProfileProps Properties for defining a \`AWS::EKS::FargateProfile\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -86148,26 +88332,26 @@ import { aws_eks } from 'aws-cdk-lib' const cfnFargateProfileProps: aws_eks.CfnFargateProfileProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#awscdklibawsekscfnfargateprofilepropspropertyclustername)* | \`string\` | \`AWS::EKS::FargateProfile.ClusterName\`. | -| [\`podExecutionRoleArn\`](#awscdklibawsekscfnfargateprofilepropspropertypodexecutionrolearn)* | \`string\` | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | -| [\`selectors\`](#awscdklibawsekscfnfargateprofilepropspropertyselectors)* | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::FargateProfile.Selectors\`. | -| [\`fargateProfileName\`](#awscdklibawsekscfnfargateprofilepropspropertyfargateprofilename) | \`string\` | \`AWS::EKS::FargateProfile.FargateProfileName\`. | -| [\`subnets\`](#awscdklibawsekscfnfargateprofilepropspropertysubnets) | \`string\`[] | \`AWS::EKS::FargateProfile.Subnets\`. | -| [\`tags\`](#awscdklibawsekscfnfargateprofilepropspropertytags) | [\`aws-cdk-lib.CfnTag\`](#aws-cdk-lib.CfnTag)[] | \`AWS::EKS::FargateProfile.Tags\`. | +| clusterName | string | \`AWS::EKS::FargateProfile.ClusterName\`. | +| podExecutionRoleArn | string | \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. | +| selectors | aws-cdk-lib.IResolvable \\\\| SelectorProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::FargateProfile.Selectors\`. | +| fargateProfileName | string | \`AWS::EKS::FargateProfile.FargateProfileName\`. | +| subnets | string[] | \`AWS::EKS::FargateProfile.Subnets\`. | +| tags | aws-cdk-lib.CfnTag[] | \`AWS::EKS::FargateProfile.Tags\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.ClusterName\`. @@ -86175,13 +88359,13 @@ public readonly clusterName: string; --- -##### \`podExecutionRoleArn\`Required +##### \`podExecutionRoleArn\`Required \`\`\`typescript public readonly podExecutionRoleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.PodExecutionRoleArn\`. @@ -86189,13 +88373,13 @@ public readonly podExecutionRoleArn: string; --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`typescript public readonly selectors: IResolvable | SelectorProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.SelectorProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | SelectorProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::FargateProfile.Selectors\`. @@ -86203,13 +88387,13 @@ public readonly selectors: IResolvable | SelectorProperty | IResolvable[]; --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`typescript public readonly fargateProfileName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::FargateProfile.FargateProfileName\`. @@ -86217,13 +88401,13 @@ public readonly fargateProfileName: string; --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`typescript public readonly subnets: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::FargateProfile.Subnets\`. @@ -86231,13 +88415,13 @@ public readonly subnets: string[]; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`aws-cdk-lib.CfnTag\`](#aws-cdk-lib.CfnTag)[] +- *Type:* aws-cdk-lib.CfnTag[] \`AWS::EKS::FargateProfile.Tags\`. @@ -86245,13 +88429,13 @@ public readonly tags: CfnTag[]; --- -### CfnNodegroupProps +### CfnNodegroupProps Properties for defining a \`AWS::EKS::Nodegroup\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -86259,37 +88443,37 @@ import { aws_eks } from 'aws-cdk-lib' const cfnNodegroupProps: aws_eks.CfnNodegroupProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#awscdklibawsekscfnnodegrouppropspropertyclustername)* | \`string\` | \`AWS::EKS::Nodegroup.ClusterName\`. | -| [\`nodeRole\`](#awscdklibawsekscfnnodegrouppropspropertynoderole)* | \`string\` | \`AWS::EKS::Nodegroup.NodeRole\`. | -| [\`subnets\`](#awscdklibawsekscfnnodegrouppropspropertysubnets)* | \`string\`[] | \`AWS::EKS::Nodegroup.Subnets\`. | -| [\`amiType\`](#awscdklibawsekscfnnodegrouppropspropertyamitype) | \`string\` | \`AWS::EKS::Nodegroup.AmiType\`. | -| [\`capacityType\`](#awscdklibawsekscfnnodegrouppropspropertycapacitytype) | \`string\` | \`AWS::EKS::Nodegroup.CapacityType\`. | -| [\`diskSize\`](#awscdklibawsekscfnnodegrouppropspropertydisksize) | \`number\` | \`AWS::EKS::Nodegroup.DiskSize\`. | -| [\`forceUpdateEnabled\`](#awscdklibawsekscfnnodegrouppropspropertyforceupdateenabled) | \`boolean\` \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | -| [\`instanceTypes\`](#awscdklibawsekscfnnodegrouppropspropertyinstancetypes) | \`string\`[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | -| [\`labels\`](#awscdklibawsekscfnnodegrouppropspropertylabels) | \`any\` | \`AWS::EKS::Nodegroup.Labels\`. | -| [\`launchTemplate\`](#awscdklibawsekscfnnodegrouppropspropertylaunchtemplate) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | -| [\`nodegroupName\`](#awscdklibawsekscfnnodegrouppropspropertynodegroupname) | \`string\` | \`AWS::EKS::Nodegroup.NodegroupName\`. | -| [\`releaseVersion\`](#awscdklibawsekscfnnodegrouppropspropertyreleaseversion) | \`string\` | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | -| [\`remoteAccess\`](#awscdklibawsekscfnnodegrouppropspropertyremoteaccess) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.RemoteAccess\`. | -| [\`scalingConfig\`](#awscdklibawsekscfnnodegrouppropspropertyscalingconfig) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`AWS::EKS::Nodegroup.ScalingConfig\`. | -| [\`tags\`](#awscdklibawsekscfnnodegrouppropspropertytags) | \`any\` | \`AWS::EKS::Nodegroup.Tags\`. | -| [\`taints\`](#awscdklibawsekscfnnodegrouppropspropertytaints) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`AWS::EKS::Nodegroup.Taints\`. | -| [\`version\`](#awscdklibawsekscfnnodegrouppropspropertyversion) | \`string\` | \`AWS::EKS::Nodegroup.Version\`. | +| clusterName | string | \`AWS::EKS::Nodegroup.ClusterName\`. | +| nodeRole | string | \`AWS::EKS::Nodegroup.NodeRole\`. | +| subnets | string[] | \`AWS::EKS::Nodegroup.Subnets\`. | +| amiType | string | \`AWS::EKS::Nodegroup.AmiType\`. | +| capacityType | string | \`AWS::EKS::Nodegroup.CapacityType\`. | +| diskSize | number | \`AWS::EKS::Nodegroup.DiskSize\`. | +| forceUpdateEnabled | boolean \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. | +| instanceTypes | string[] | \`AWS::EKS::Nodegroup.InstanceTypes\`. | +| labels | any | \`AWS::EKS::Nodegroup.Labels\`. | +| launchTemplate | LaunchTemplateSpecificationProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.LaunchTemplate\`. | +| nodegroupName | string | \`AWS::EKS::Nodegroup.NodegroupName\`. | +| releaseVersion | string | \`AWS::EKS::Nodegroup.ReleaseVersion\`. | +| remoteAccess | RemoteAccessProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.RemoteAccess\`. | +| scalingConfig | ScalingConfigProperty \\\\| aws-cdk-lib.IResolvable | \`AWS::EKS::Nodegroup.ScalingConfig\`. | +| tags | any | \`AWS::EKS::Nodegroup.Tags\`. | +| taints | aws-cdk-lib.IResolvable \\\\| TaintProperty \\\\| aws-cdk-lib.IResolvable[] | \`AWS::EKS::Nodegroup.Taints\`. | +| version | string | \`AWS::EKS::Nodegroup.Version\`. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ClusterName\`. @@ -86297,13 +88481,13 @@ public readonly clusterName: string; --- -##### \`nodeRole\`Required +##### \`nodeRole\`Required \`\`\`typescript public readonly nodeRole: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodeRole\`. @@ -86311,13 +88495,13 @@ public readonly nodeRole: string; --- -##### \`subnets\`Required +##### \`subnets\`Required \`\`\`typescript public readonly subnets: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.Subnets\`. @@ -86325,13 +88509,13 @@ public readonly subnets: string[]; --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`typescript public readonly amiType: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.AmiType\`. @@ -86339,13 +88523,13 @@ public readonly amiType: string; --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`typescript public readonly capacityType: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.CapacityType\`. @@ -86353,13 +88537,13 @@ public readonly capacityType: string; --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`typescript public readonly diskSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number \`AWS::EKS::Nodegroup.DiskSize\`. @@ -86367,13 +88551,13 @@ public readonly diskSize: number; --- -##### \`forceUpdateEnabled\`Optional +##### \`forceUpdateEnabled\`Optional \`\`\`typescript public readonly forceUpdateEnabled: boolean | IResolvable; \`\`\` -- *Type:* \`boolean\` | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* boolean | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.ForceUpdateEnabled\`. @@ -86381,13 +88565,13 @@ public readonly forceUpdateEnabled: boolean | IResolvable; --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`typescript public readonly instanceTypes: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`AWS::EKS::Nodegroup.InstanceTypes\`. @@ -86395,13 +88579,13 @@ public readonly instanceTypes: string[]; --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`typescript public readonly labels: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::EKS::Nodegroup.Labels\`. @@ -86409,13 +88593,13 @@ public readonly labels: any; --- -##### \`launchTemplate\`Optional +##### \`launchTemplate\`Optional \`\`\`typescript public readonly launchTemplate: LaunchTemplateSpecificationProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* LaunchTemplateSpecificationProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.LaunchTemplate\`. @@ -86423,13 +88607,13 @@ public readonly launchTemplate: LaunchTemplateSpecificationProperty | IResolvabl --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.NodegroupName\`. @@ -86437,13 +88621,13 @@ public readonly nodegroupName: string; --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`typescript public readonly releaseVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.ReleaseVersion\`. @@ -86451,13 +88635,13 @@ public readonly releaseVersion: string; --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`typescript public readonly remoteAccess: RemoteAccessProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.RemoteAccessProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* RemoteAccessProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.RemoteAccess\`. @@ -86465,13 +88649,13 @@ public readonly remoteAccess: RemoteAccessProperty | IResolvable; --- -##### \`scalingConfig\`Optional +##### \`scalingConfig\`Optional \`\`\`typescript public readonly scalingConfig: ScalingConfigProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.ScalingConfigProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* ScalingConfigProperty | aws-cdk-lib.IResolvable \`AWS::EKS::Nodegroup.ScalingConfig\`. @@ -86479,13 +88663,13 @@ public readonly scalingConfig: ScalingConfigProperty | IResolvable; --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::EKS::Nodegroup.Tags\`. @@ -86493,13 +88677,13 @@ public readonly tags: any; --- -##### \`taints\`Optional +##### \`taints\`Optional \`\`\`typescript public readonly taints: IResolvable | TaintProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty\`](#aws-cdk-lib.aws_eks.CfnNodegroup.TaintProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | TaintProperty | aws-cdk-lib.IResolvable[] \`AWS::EKS::Nodegroup.Taints\`. @@ -86507,13 +88691,13 @@ public readonly taints: IResolvable | TaintProperty | IResolvable[]; --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::EKS::Nodegroup.Version\`. @@ -86521,11 +88705,11 @@ public readonly version: string; --- -### ClusterAttributes +### ClusterAttributes Attributes for EKS clusters. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -86533,112 +88717,112 @@ import { aws_eks } from 'aws-cdk-lib' const clusterAttributes: aws_eks.ClusterAttributes = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`clusterName\`](#awscdklibawseksclusterattributespropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`clusterCertificateAuthorityData\`](#awscdklibawseksclusterattributespropertyclustercertificateauthoritydata) | \`string\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#awscdklibawseksclusterattributespropertyclusterencryptionconfigkeyarn) | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#awscdklibawseksclusterattributespropertyclusterendpoint) | \`string\` | The API Server endpoint URL. | -| [\`clusterSecurityGroupId\`](#awscdklibawseksclusterattributespropertyclustersecuritygroupid) | \`string\` | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`kubectlEnvironment\`](#awscdklibawseksclusterattributespropertykubectlenvironment) | {[ key: string ]: \`string\`} | Environment variables to use when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#awscdklibawseksclusterattributespropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#awscdklibawseksclusterattributespropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnetIds\`](#awscdklibawseksclusterattributespropertykubectlprivatesubnetids) | \`string\`[] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRoleArn\`](#awscdklibawseksclusterattributespropertykubectlrolearn) | \`string\` | An IAM role with cluster administrator and \\"system:masters\\" permissions. | -| [\`kubectlSecurityGroupId\`](#awscdklibawseksclusterattributespropertykubectlsecuritygroupid) | \`string\` | A security group to use for \`kubectl\` execution. | -| [\`openIdConnectProvider\`](#awscdklibawseksclusterattributespropertyopenidconnectprovider) | [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) | An Open ID Connect provider for this cluster that can be used to configure service accounts. | -| [\`prune\`](#awscdklibawseksclusterattributespropertyprune) | \`boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`securityGroupIds\`](#awscdklibawseksclusterattributespropertysecuritygroupids) | \`string\`[] | Additional security groups associated with this cluster. | -| [\`vpc\`](#awscdklibawseksclusterattributespropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which this Cluster was created. | +| clusterName | string | The physical name of the Cluster. | +| clusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | string | The API Server endpoint URL. | +| clusterSecurityGroupId | string | The cluster security group that was created by Amazon EKS for the cluster. | +| kubectlEnvironment | {[ key: string ]: string} | Environment variables to use when running \`kubectl\` against this cluster. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | aws-cdk-lib.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnetIds | string[] | Subnets to host the \`kubectl\` compute resources. | +| kubectlRoleArn | string | An IAM role with cluster administrator and \\"system:masters\\" permissions. | +| kubectlSecurityGroupId | string | A security group to use for \`kubectl\` execution. | +| openIdConnectProvider | aws-cdk-lib.aws_iam.IOpenIdConnectProvider | An Open ID Connect provider for this cluster that can be used to configure service accounts. | +| prune | boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| securityGroupIds | string[] | Additional security groups associated with this cluster. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which this Cluster was created. | --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`clusterCertificateAuthorityData\`Optional +##### \`clusterCertificateAuthorityData\`Optional \`\`\`typescript public readonly clusterCertificateAuthorityData: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterCertificateAuthorityData\` will throw an error The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Optional +##### \`clusterEncryptionConfigKeyArn\`Optional \`\`\`typescript public readonly clusterEncryptionConfigKeyArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEncryptionConfigKeyArn\` will throw an error Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Optional +##### \`clusterEndpoint\`Optional \`\`\`typescript public readonly clusterEndpoint: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterEndpoint\` will throw an error. The API Server endpoint URL. --- -##### \`clusterSecurityGroupId\`Optional +##### \`clusterSecurityGroupId\`Optional \`\`\`typescript public readonly clusterSecurityGroupId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified \`cluster.clusterSecurityGroupId\` will throw an error The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* no additional variables Environment variables to use when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion - *Default:* a layer bundled with this module. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. @@ -86647,26 +88831,26 @@ This layer is used by the kubectl handler to apply manifests and install helm ch --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnetIds\`Optional +##### \`kubectlPrivateSubnetIds\`Optional \`\`\`typescript public readonly kubectlPrivateSubnetIds: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* k8s endpoint is expected to be accessible publicly Subnets to host the \`kubectl\` compute resources. @@ -86675,26 +88859,26 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRoleArn\`Optional +##### \`kubectlRoleArn\`Optional \`\`\`typescript public readonly kubectlRoleArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* if not specified, it not be possible to issue \`kubectl\` commands against an imported cluster. An IAM role with cluster administrator and \\"system:masters\\" permissions. --- -##### \`kubectlSecurityGroupId\`Optional +##### \`kubectlSecurityGroupId\`Optional \`\`\`typescript public readonly kubectlSecurityGroupId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* k8s endpoint is expected to be accessible publicly A security group to use for \`kubectl\` execution. @@ -86703,13 +88887,13 @@ If not specified, the k8s endpoint is expected to be accessible publicly. --- -##### \`openIdConnectProvider\`Optional +##### \`openIdConnectProvider\`Optional \`\`\`typescript public readonly openIdConnectProvider: IOpenIdConnectProvider; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) +- *Type:* aws-cdk-lib.aws_iam.IOpenIdConnectProvider - *Default:* if not specified \`cluster.openIdConnectProvider\` and \`cluster.addServiceAccount\` will throw an error. An Open ID Connect provider for this cluster that can be used to configure service accounts. @@ -86718,13 +88902,13 @@ You can either import an existing provider using \`iam.OpenIdConnectProvider.fro --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -86733,37 +88917,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`typescript public readonly securityGroupIds: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] - *Default:* if not specified, no additional security groups will be considered in \`cluster.connections\`. Additional security groups associated with this cluster. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* if not specified \`cluster.vpc\` will throw an error The VPC in which this Cluster was created. --- -### ClusterOptions +### ClusterOptions Options for EKS clusters. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -86771,77 +88955,77 @@ import { aws_eks } from 'aws-cdk-lib' const clusterOptions: aws_eks.ClusterOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdklibawseksclusteroptionspropertyversion)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#awscdklibawseksclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`outputClusterName\`](#awscdklibawseksclusteroptionspropertyoutputclustername) | \`boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#awscdklibawseksclusteroptionspropertyoutputconfigcommand) | \`boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdklibawseksclusteroptionspropertyrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#awscdklibawseksclusteroptionspropertysecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdklibawseksclusteroptionspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#awscdklibawseksclusteroptionspropertyvpcsubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#awscdklibawseksclusteroptionspropertyclusterhandlerenvironment) | {[ key: string ]: \`string\`} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#awscdklibawseksclusteroptionspropertycorednscomputetype) | [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#awscdklibawseksclusteroptionspropertyendpointaccess) | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#awscdklibawseksclusteroptionspropertykubectlenvironment) | {[ key: string ]: \`string\`} | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#awscdklibawseksclusteroptionspropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#awscdklibawseksclusteroptionspropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#awscdklibawseksclusteroptionspropertymastersrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#awscdklibawseksclusteroptionspropertyoutputmastersrolearn) | \`boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#awscdklibawseksclusteroptionspropertyplaceclusterhandlerinvpc) | \`boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdklibawseksclusteroptionspropertyprune) | \`boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#awscdklibawseksclusteroptionspropertysecretsencryptionkey) | [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | string | Name for the cluster. | +| outputClusterName | boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws-cdk-lib.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | {[ key: string ]: string} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | {[ key: string ]: string} | Environment variables for the kubectl execution. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | aws-cdk-lib.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | aws-cdk-lib.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | aws-cdk-lib.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`typescript public readonly version: KubernetesVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`typescript public readonly outputClusterName: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`typescript public readonly outputConfigCommand: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -86850,52 +89034,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`typescript public readonly securityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`typescript public readonly vpcSubnets: SubnetSelection[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -86904,54 +89088,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`typescript public readonly clusterHandlerEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`typescript public readonly coreDnsComputeType: CoreDnsComputeType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`typescript public readonly endpointAccess: EndpointAccess; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -86960,84 +89144,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`ts const layer = new lambda.LayerVersion(this, 'kubectl-layer', { code: lambda.Code.fromAsset(\`\${__dirname}/layer.zip\`)), compatibleRuntimes: [lambda.Runtime.PROVIDED] }) \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`typescript public readonly mastersRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`typescript public readonly outputMastersRoleArn: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`typescript public readonly placeClusterHandlerInVpc: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -87046,24 +89230,24 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`typescript public readonly secretsEncryptionKey: IKey; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) +- *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -### ClusterProps +### ClusterProps Common configuration props for EKS clusters. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87071,80 +89255,80 @@ import { aws_eks } from 'aws-cdk-lib' const clusterProps: aws_eks.ClusterProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdklibawseksclusterpropspropertyversion)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#awscdklibawseksclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`outputClusterName\`](#awscdklibawseksclusterpropspropertyoutputclustername) | \`boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#awscdklibawseksclusterpropspropertyoutputconfigcommand) | \`boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdklibawseksclusterpropspropertyrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#awscdklibawseksclusterpropspropertysecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdklibawseksclusterpropspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#awscdklibawseksclusterpropspropertyvpcsubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#awscdklibawseksclusterpropspropertyclusterhandlerenvironment) | {[ key: string ]: \`string\`} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#awscdklibawseksclusterpropspropertycorednscomputetype) | [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#awscdklibawseksclusterpropspropertyendpointaccess) | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#awscdklibawseksclusterpropspropertykubectlenvironment) | {[ key: string ]: \`string\`} | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#awscdklibawseksclusterpropspropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#awscdklibawseksclusterpropspropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#awscdklibawseksclusterpropspropertymastersrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#awscdklibawseksclusterpropspropertyoutputmastersrolearn) | \`boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#awscdklibawseksclusterpropspropertyplaceclusterhandlerinvpc) | \`boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdklibawseksclusterpropspropertyprune) | \`boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#awscdklibawseksclusterpropspropertysecretsencryptionkey) | [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultCapacity\`](#awscdklibawseksclusterpropspropertydefaultcapacity) | \`number\` | Number of instances to allocate as an initial capacity for this cluster. | -| [\`defaultCapacityInstance\`](#awscdklibawseksclusterpropspropertydefaultcapacityinstance) | [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType) | The instance type to use for the default capacity. | -| [\`defaultCapacityType\`](#awscdklibawseksclusterpropspropertydefaultcapacitytype) | [\`aws-cdk-lib.aws_eks.DefaultCapacityType\`](#aws-cdk-lib.aws_eks.DefaultCapacityType) | The default capacity type for the cluster. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | string | Name for the cluster. | +| outputClusterName | boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws-cdk-lib.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | {[ key: string ]: string} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | {[ key: string ]: string} | Environment variables for the kubectl execution. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | aws-cdk-lib.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | aws-cdk-lib.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | aws-cdk-lib.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultCapacity | number | Number of instances to allocate as an initial capacity for this cluster. | +| defaultCapacityInstance | aws-cdk-lib.aws_ec2.InstanceType | The instance type to use for the default capacity. | +| defaultCapacityType | DefaultCapacityType | The default capacity type for the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`typescript public readonly version: KubernetesVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`typescript public readonly outputClusterName: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`typescript public readonly outputConfigCommand: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -87153,52 +89337,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`typescript public readonly securityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`typescript public readonly vpcSubnets: SubnetSelection[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -87207,54 +89391,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`typescript public readonly clusterHandlerEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`typescript public readonly coreDnsComputeType: CoreDnsComputeType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`typescript public readonly endpointAccess: EndpointAccess; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -87263,84 +89447,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`ts const layer = new lambda.LayerVersion(this, 'kubectl-layer', { code: lambda.Code.fromAsset(\`\${__dirname}/layer.zip\`)), compatibleRuntimes: [lambda.Runtime.PROVIDED] }) \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`typescript public readonly mastersRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`typescript public readonly outputMastersRoleArn: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`typescript public readonly placeClusterHandlerInVpc: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -87349,26 +89533,26 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`typescript public readonly secretsEncryptionKey: IKey; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) +- *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultCapacity\`Optional +##### \`defaultCapacity\`Optional \`\`\`typescript public readonly defaultCapacity: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 2 Number of instances to allocate as an initial capacity for this cluster. @@ -87377,13 +89561,13 @@ Instance type can be configured through \`defaultCapacityInstanceType\`, which d --- -##### \`defaultCapacityInstance\`Optional +##### \`defaultCapacityInstance\`Optional \`\`\`typescript public readonly defaultCapacityInstance: InstanceType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType) +- *Type:* aws-cdk-lib.aws_ec2.InstanceType - *Default:* m5.large The instance type to use for the default capacity. @@ -87392,24 +89576,24 @@ This will only be taken into account if \`defaultCapacity\` is > 0. --- -##### \`defaultCapacityType\`Optional +##### \`defaultCapacityType\`Optional \`\`\`typescript public readonly defaultCapacityType: DefaultCapacityType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.DefaultCapacityType\`](#aws-cdk-lib.aws_eks.DefaultCapacityType) +- *Type:* DefaultCapacityType - *Default:* NODEGROUP The default capacity type for the cluster. --- -### CommonClusterOptions +### CommonClusterOptions Options for configuring an EKS cluster. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87417,66 +89601,66 @@ import { aws_eks } from 'aws-cdk-lib' const commonClusterOptions: aws_eks.CommonClusterOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdklibawsekscommonclusteroptionspropertyversion)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#awscdklibawsekscommonclusteroptionspropertyclustername) | \`string\` | Name for the cluster. | -| [\`outputClusterName\`](#awscdklibawsekscommonclusteroptionspropertyoutputclustername) | \`boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#awscdklibawsekscommonclusteroptionspropertyoutputconfigcommand) | \`boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdklibawsekscommonclusteroptionspropertyrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#awscdklibawsekscommonclusteroptionspropertysecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdklibawsekscommonclusteroptionspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#awscdklibawsekscommonclusteroptionspropertyvpcsubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | string | Name for the cluster. | +| outputClusterName | boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws-cdk-lib.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`typescript public readonly version: KubernetesVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`typescript public readonly outputClusterName: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`typescript public readonly outputConfigCommand: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -87485,52 +89669,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`typescript public readonly securityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`typescript public readonly vpcSubnets: SubnetSelection[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -87539,11 +89723,11 @@ If you want to create public load balancers, this must include public subnets. --- -### EksOptimizedImageProps +### EksOptimizedImageProps Properties for EksOptimizedImage. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87551,60 +89735,60 @@ import { aws_eks } from 'aws-cdk-lib' const eksOptimizedImageProps: aws_eks.EksOptimizedImageProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cpuArch\`](#awscdklibawsekseksoptimizedimagepropspropertycpuarch) | [\`aws-cdk-lib.aws_eks.CpuArch\`](#aws-cdk-lib.aws_eks.CpuArch) | What cpu architecture to retrieve the image for (arm64 or x86_64). | -| [\`kubernetesVersion\`](#awscdklibawsekseksoptimizedimagepropspropertykubernetesversion) | \`string\` | The Kubernetes version to use. | -| [\`nodeType\`](#awscdklibawsekseksoptimizedimagepropspropertynodetype) | [\`aws-cdk-lib.aws_eks.NodeType\`](#aws-cdk-lib.aws_eks.NodeType) | What instance type to retrieve the image for (standard or GPU-optimized). | +| cpuArch | CpuArch | What cpu architecture to retrieve the image for (arm64 or x86_64). | +| kubernetesVersion | string | The Kubernetes version to use. | +| nodeType | NodeType | What instance type to retrieve the image for (standard or GPU-optimized). | --- -##### \`cpuArch\`Optional +##### \`cpuArch\`Optional \`\`\`typescript public readonly cpuArch: CpuArch; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CpuArch\`](#aws-cdk-lib.aws_eks.CpuArch) +- *Type:* CpuArch - *Default:* CpuArch.X86_64 What cpu architecture to retrieve the image for (arm64 or x86_64). --- -##### \`kubernetesVersion\`Optional +##### \`kubernetesVersion\`Optional \`\`\`typescript public readonly kubernetesVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest version The Kubernetes version to use. --- -##### \`nodeType\`Optional +##### \`nodeType\`Optional \`\`\`typescript public readonly nodeType: NodeType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.NodeType\`](#aws-cdk-lib.aws_eks.NodeType) +- *Type:* NodeType - *Default:* NodeType.STANDARD What instance type to retrieve the image for (standard or GPU-optimized). --- -### EncryptionConfigProperty +### EncryptionConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87612,22 +89796,22 @@ import { aws_eks } from 'aws-cdk-lib' const encryptionConfigProperty: aws_eks.CfnCluster.EncryptionConfigProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`provider\`](#awscdklibawsekscfnclusterencryptionconfigpropertypropertyprovider) | [\`aws-cdk-lib.aws_eks.CfnCluster.ProviderProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ProviderProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | \`CfnCluster.EncryptionConfigProperty.Provider\`. | -| [\`resources\`](#awscdklibawsekscfnclusterencryptionconfigpropertypropertyresources) | \`string\`[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | +| provider | ProviderProperty \\\\| aws-cdk-lib.IResolvable | \`CfnCluster.EncryptionConfigProperty.Provider\`. | +| resources | string[] | \`CfnCluster.EncryptionConfigProperty.Resources\`. | --- -##### \`provider\`Optional +##### \`provider\`Optional \`\`\`typescript public readonly provider: ProviderProperty | IResolvable; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CfnCluster.ProviderProperty\`](#aws-cdk-lib.aws_eks.CfnCluster.ProviderProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) +- *Type:* ProviderProperty | aws-cdk-lib.IResolvable \`CfnCluster.EncryptionConfigProperty.Provider\`. @@ -87635,13 +89819,13 @@ public readonly provider: ProviderProperty | IResolvable; --- -##### \`resources\`Optional +##### \`resources\`Optional \`\`\`typescript public readonly resources: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.EncryptionConfigProperty.Resources\`. @@ -87649,11 +89833,11 @@ public readonly resources: string[]; --- -### FargateClusterProps +### FargateClusterProps Configuration props for EKS Fargate. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87661,78 +89845,78 @@ import { aws_eks } from 'aws-cdk-lib' const fargateClusterProps: aws_eks.FargateClusterProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdklibawseksfargateclusterpropspropertyversion)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | The Kubernetes version to run in the cluster. | -| [\`clusterName\`](#awscdklibawseksfargateclusterpropspropertyclustername) | \`string\` | Name for the cluster. | -| [\`outputClusterName\`](#awscdklibawseksfargateclusterpropspropertyoutputclustername) | \`boolean\` | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | -| [\`outputConfigCommand\`](#awscdklibawseksfargateclusterpropspropertyoutputconfigcommand) | \`boolean\` | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | -| [\`role\`](#awscdklibawseksfargateclusterpropspropertyrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | -| [\`securityGroup\`](#awscdklibawseksfargateclusterpropspropertysecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | Security Group to use for Control Plane ENIs. | -| [\`vpc\`](#awscdklibawseksfargateclusterpropspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which to create the Cluster. | -| [\`vpcSubnets\`](#awscdklibawseksfargateclusterpropspropertyvpcsubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] | Where to place EKS Control Plane ENIs. | -| [\`clusterHandlerEnvironment\`](#awscdklibawseksfargateclusterpropspropertyclusterhandlerenvironment) | {[ key: string ]: \`string\`} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | -| [\`coreDnsComputeType\`](#awscdklibawseksfargateclusterpropspropertycorednscomputetype) | [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | -| [\`endpointAccess\`](#awscdklibawseksfargateclusterpropspropertyendpointaccess) | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | Configure access to the Kubernetes API server endpoint.. | -| [\`kubectlEnvironment\`](#awscdklibawseksfargateclusterpropspropertykubectlenvironment) | {[ key: string ]: \`string\`} | Environment variables for the kubectl execution. | -| [\`kubectlLayer\`](#awscdklibawseksfargateclusterpropspropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | -| [\`kubectlMemory\`](#awscdklibawseksfargateclusterpropspropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`mastersRole\`](#awscdklibawseksfargateclusterpropspropertymastersrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | -| [\`outputMastersRoleArn\`](#awscdklibawseksfargateclusterpropspropertyoutputmastersrolearn) | \`boolean\` | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | -| [\`placeClusterHandlerInVpc\`](#awscdklibawseksfargateclusterpropspropertyplaceclusterhandlerinvpc) | \`boolean\` | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | -| [\`prune\`](#awscdklibawseksfargateclusterpropspropertyprune) | \`boolean\` | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | -| [\`secretsEncryptionKey\`](#awscdklibawseksfargateclusterpropspropertysecretsencryptionkey) | [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) | KMS secret for envelope encryption for Kubernetes secrets. | -| [\`defaultProfile\`](#awscdklibawseksfargateclusterpropspropertydefaultprofile) | [\`aws-cdk-lib.aws_eks.FargateProfileOptions\`](#aws-cdk-lib.aws_eks.FargateProfileOptions) | Fargate Profile to create along with the cluster. | +| version | KubernetesVersion | The Kubernetes version to run in the cluster. | +| clusterName | string | Name for the cluster. | +| outputClusterName | boolean | Determines whether a CloudFormation output with the name of the cluster will be synthesized. | +| outputConfigCommand | boolean | Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. | +| role | aws-cdk-lib.aws_iam.IRole | Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. | +| securityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | Security Group to use for Control Plane ENIs. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which to create the Cluster. | +| vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection[] | Where to place EKS Control Plane ENIs. | +| clusterHandlerEnvironment | {[ key: string ]: string} | Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. | +| coreDnsComputeType | CoreDnsComputeType | Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. | +| endpointAccess | EndpointAccess | Configure access to the Kubernetes API server endpoint.. | +| kubectlEnvironment | {[ key: string ]: string} | Environment variables for the kubectl execution. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. | +| kubectlMemory | aws-cdk-lib.Size | Amount of memory to allocate to the provider's lambda function. | +| mastersRole | aws-cdk-lib.aws_iam.IRole | An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. | +| outputMastersRoleArn | boolean | Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). | +| placeClusterHandlerInVpc | boolean | If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. | +| prune | boolean | Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. | +| secretsEncryptionKey | aws-cdk-lib.aws_kms.IKey | KMS secret for envelope encryption for Kubernetes secrets. | +| defaultProfile | FargateProfileOptions | Fargate Profile to create along with the cluster. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`typescript public readonly version: KubernetesVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion The Kubernetes version to run in the cluster. --- -##### \`clusterName\`Optional +##### \`clusterName\`Optional \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* Automatically generated name Name for the cluster. --- -##### \`outputClusterName\`Optional +##### \`outputClusterName\`Optional \`\`\`typescript public readonly outputClusterName: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the name of the cluster will be synthesized. --- -##### \`outputConfigCommand\`Optional +##### \`outputConfigCommand\`Optional \`\`\`typescript public readonly outputConfigCommand: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Determines whether a CloudFormation output with the \`aws eks update-kubeconfig\` command will be synthesized. @@ -87741,52 +89925,52 @@ This command will include the cluster name and, if applicable, the ARN of the ma --- -##### \`role\`Optional +##### \`role\`Optional \`\`\`typescript public readonly role: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A role is automatically created for you Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. --- -##### \`securityGroup\`Optional +##### \`securityGroup\`Optional \`\`\`typescript public readonly securityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup - *Default:* A security group is automatically created Security Group to use for Control Plane ENIs. --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* a VPC with default configuration will be created and can be accessed through \`cluster.vpc\`. The VPC in which to create the Cluster. --- -##### \`vpcSubnets\`Optional +##### \`vpcSubnets\`Optional \`\`\`typescript public readonly vpcSubnets: SubnetSelection[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection)[] +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection[] - *Default:* All public and private subnets Where to place EKS Control Plane ENIs. @@ -87795,54 +89979,54 @@ If you want to create public load balancers, this must include public subnets. --- -##### \`clusterHandlerEnvironment\`Optional +##### \`clusterHandlerEnvironment\`Optional \`\`\`typescript public readonly clusterHandlerEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. --- -##### \`coreDnsComputeType\`Optional +##### \`coreDnsComputeType\`Optional \`\`\`typescript public readonly coreDnsComputeType: CoreDnsComputeType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CoreDnsComputeType\`](#aws-cdk-lib.aws_eks.CoreDnsComputeType) +- *Type:* CoreDnsComputeType - *Default:* CoreDnsComputeType.EC2 (for \`FargateCluster\` the default is FARGATE) Controls the \\"eks.amazonaws.com/compute-type\\" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. --- -##### \`endpointAccess\`Optional +##### \`endpointAccess\`Optional \`\`\`typescript public readonly endpointAccess: EndpointAccess; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +- *Type:* EndpointAccess - *Default:* EndpointAccess.PUBLIC_AND_PRIVATE Configure access to the Kubernetes API server endpoint.. -> https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +> [https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* No environment variables. Environment variables for the kubectl execution. @@ -87851,84 +90035,84 @@ Only relevant for kubectl enabled clusters. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion - *Default:* the layer provided by the \`aws-lambda-layer-kubectl\` SAR app. An AWS Lambda Layer which includes \`kubectl\`, Helm and the AWS CLI. By default, the provider will use the layer included in the \\"aws-lambda-layer-kubectl\\" SAR application which is available in all commercial regions. To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows: \`\`\`ts const layer = new lambda.LayerVersion(this, 'kubectl-layer', { code: lambda.Code.fromAsset(\`\${__dirname}/layer.zip\`)), compatibleRuntimes: [lambda.Runtime.PROVIDED] }) \`\`\` -> https://github.com/aws-samples/aws-lambda-layer-kubectl +> [https://github.com/aws-samples/aws-lambda-layer-kubectl](https://github.com/aws-samples/aws-lambda-layer-kubectl) --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size - *Default:* Size.gibibytes(1) Amount of memory to allocate to the provider's lambda function. --- -##### \`mastersRole\`Optional +##### \`mastersRole\`Optional \`\`\`typescript public readonly mastersRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role that assumable by anyone with permissions in the same account will automatically be defined An IAM role that will be added to the \`system:masters\` Kubernetes RBAC group. -> https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings +> [https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings) --- -##### \`outputMastersRoleArn\`Optional +##### \`outputMastersRoleArn\`Optional \`\`\`typescript public readonly outputMastersRoleArn: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Determines whether a CloudFormation output with the ARN of the \\"masters\\" IAM role will be synthesized (if \`mastersRole\` is specified). --- -##### \`placeClusterHandlerInVpc\`Optional +##### \`placeClusterHandlerInVpc\`Optional \`\`\`typescript public readonly placeClusterHandlerInVpc: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the \`vpcSubnets\` selection strategy. --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Indicates whether Kubernetes resources added through \`addManifest()\` can be automatically pruned. @@ -87937,37 +90121,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`secretsEncryptionKey\`Optional +##### \`secretsEncryptionKey\`Optional \`\`\`typescript public readonly secretsEncryptionKey: IKey; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_kms.IKey\`](#aws-cdk-lib.aws_kms.IKey) +- *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys. KMS secret for envelope encryption for Kubernetes secrets. --- -##### \`defaultProfile\`Optional +##### \`defaultProfile\`Optional \`\`\`typescript public readonly defaultProfile: FargateProfileOptions; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.FargateProfileOptions\`](#aws-cdk-lib.aws_eks.FargateProfileOptions) +- *Type:* FargateProfileOptions - *Default:* A profile called \\"default\\" with 'default' and 'kube-system' selectors will be created if this is left undefined. Fargate Profile to create along with the cluster. --- -### FargateProfileOptions +### FargateProfileOptions Options for defining EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -87975,25 +90159,25 @@ import { aws_eks } from 'aws-cdk-lib' const fargateProfileOptions: aws_eks.FargateProfileOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#awscdklibawseksfargateprofileoptionspropertyselectors)* | [\`aws-cdk-lib.aws_eks.Selector\`](#aws-cdk-lib.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#awscdklibawseksfargateprofileoptionspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#awscdklibawseksfargateprofileoptionspropertypodexecutionrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#awscdklibawseksfargateprofileoptionspropertysubnetselection) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#awscdklibawseksfargateprofileoptionspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | +| selectors | Selector[] | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | string | The name of the Fargate profile. | +| podExecutionRole | aws-cdk-lib.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | aws-cdk-lib.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`typescript public readonly selectors: Selector[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.Selector\`](#aws-cdk-lib.aws_eks.Selector)[] +- *Type:* Selector[] The selectors to match for pods to use this Fargate profile. @@ -88001,43 +90185,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`typescript public readonly fargateProfileName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`typescript public readonly podExecutionRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`typescript public readonly subnetSelection: SubnetSelection; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -88046,13 +90230,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -88061,11 +90245,11 @@ By default, all private subnets are selected. You can customize this using \`sub --- -### FargateProfileProps +### FargateProfileProps Configuration props for EKS Fargate Profiles. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88073,26 +90257,26 @@ import { aws_eks } from 'aws-cdk-lib' const fargateProfileProps: aws_eks.FargateProfileProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`selectors\`](#awscdklibawseksfargateprofilepropspropertyselectors)* | [\`aws-cdk-lib.aws_eks.Selector\`](#aws-cdk-lib.aws_eks.Selector)[] | The selectors to match for pods to use this Fargate profile. | -| [\`fargateProfileName\`](#awscdklibawseksfargateprofilepropspropertyfargateprofilename) | \`string\` | The name of the Fargate profile. | -| [\`podExecutionRole\`](#awscdklibawseksfargateprofilepropspropertypodexecutionrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The pod execution role to use for pods that match the selectors in the Fargate profile. | -| [\`subnetSelection\`](#awscdklibawseksfargateprofilepropspropertysubnetselection) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) | Select which subnets to launch your pods into. | -| [\`vpc\`](#awscdklibawseksfargateprofilepropspropertyvpc) | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC from which to select subnets to launch your pods into. | -| [\`cluster\`](#awscdklibawseksfargateprofilepropspropertycluster)* | [\`aws-cdk-lib.aws_eks.Cluster\`](#aws-cdk-lib.aws_eks.Cluster) | The EKS cluster to apply the Fargate profile to. | +| selectors | Selector[] | The selectors to match for pods to use this Fargate profile. | +| fargateProfileName | string | The name of the Fargate profile. | +| podExecutionRole | aws-cdk-lib.aws_iam.IRole | The pod execution role to use for pods that match the selectors in the Fargate profile. | +| subnetSelection | aws-cdk-lib.aws_ec2.SubnetSelection | Select which subnets to launch your pods into. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC from which to select subnets to launch your pods into. | +| cluster | Cluster | The EKS cluster to apply the Fargate profile to. | --- -##### \`selectors\`Required +##### \`selectors\`Required \`\`\`typescript public readonly selectors: Selector[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.Selector\`](#aws-cdk-lib.aws_eks.Selector)[] +- *Type:* Selector[] The selectors to match for pods to use this Fargate profile. @@ -88100,43 +90284,43 @@ Each selector must have an associated namespace. Optionally, you can also specif --- -##### \`fargateProfileName\`Optional +##### \`fargateProfileName\`Optional \`\`\`typescript public readonly fargateProfileName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* generated The name of the Fargate profile. --- -##### \`podExecutionRole\`Optional +##### \`podExecutionRole\`Optional \`\`\`typescript public readonly podExecutionRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role will be automatically created The pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. -> https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html +> [https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) --- -##### \`subnetSelection\`Optional +##### \`subnetSelection\`Optional \`\`\`typescript public readonly subnetSelection: SubnetSelection; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* all private subnets of the VPC are selected. Select which subnets to launch your pods into. @@ -88145,13 +90329,13 @@ At this time, pods running on Fargate are not assigned public IP addresses, so o --- -##### \`vpc\`Optional +##### \`vpc\`Optional \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* all private subnets used by theEKS cluster The VPC from which to select subnets to launch your pods into. @@ -88160,13 +90344,13 @@ By default, all private subnets are selected. You can customize this using \`sub --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: Cluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.Cluster\`](#aws-cdk-lib.aws_eks.Cluster) +- *Type:* Cluster The EKS cluster to apply the Fargate profile to. @@ -88174,11 +90358,11 @@ The EKS cluster to apply the Fargate profile to. --- -### HelmChartOptions +### HelmChartOptions Helm Chart options. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88186,80 +90370,80 @@ import { aws_eks } from 'aws-cdk-lib' const helmChartOptions: aws_eks.HelmChartOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#awscdklibawsekshelmchartoptionspropertychart)* | \`string\` | The name of the chart. | -| [\`createNamespace\`](#awscdklibawsekshelmchartoptionspropertycreatenamespace) | \`boolean\` | create namespace if not exist. | -| [\`namespace\`](#awscdklibawsekshelmchartoptionspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#awscdklibawsekshelmchartoptionspropertyrelease) | \`string\` | The name of the release. | -| [\`repository\`](#awscdklibawsekshelmchartoptionspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`timeout\`](#awscdklibawsekshelmchartoptionspropertytimeout) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#awscdklibawsekshelmchartoptionspropertyvalues) | {[ key: string ]: \`any\`} | The values to be used by the chart. | -| [\`version\`](#awscdklibawsekshelmchartoptionspropertyversion) | \`string\` | The chart version to install. | -| [\`wait\`](#awscdklibawsekshelmchartoptionspropertywait) | \`boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| chart | string | The name of the chart. | +| createNamespace | boolean | create namespace if not exist. | +| namespace | string | The Kubernetes namespace scope of the requests. | +| release | string | The name of the release. | +| repository | string | The repository which contains the chart. | +| timeout | aws-cdk-lib.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | {[ key: string ]: any} | The values to be used by the chart. | +| version | string | The chart version to install. | +| wait | boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`typescript public readonly chart: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`typescript public readonly createNamespace: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`typescript public readonly release: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`typescript public readonly repository: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -88268,13 +90452,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`typescript public readonly timeout: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -88283,50 +90467,50 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`typescript public readonly values: {[ key: string ]: any}; \`\`\` -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`typescript public readonly wait: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -### HelmChartProps +### HelmChartProps Helm Chart properties. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88334,81 +90518,81 @@ import { aws_eks } from 'aws-cdk-lib' const helmChartProps: aws_eks.HelmChartProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`chart\`](#awscdklibawsekshelmchartpropspropertychart)* | \`string\` | The name of the chart. | -| [\`createNamespace\`](#awscdklibawsekshelmchartpropspropertycreatenamespace) | \`boolean\` | create namespace if not exist. | -| [\`namespace\`](#awscdklibawsekshelmchartpropspropertynamespace) | \`string\` | The Kubernetes namespace scope of the requests. | -| [\`release\`](#awscdklibawsekshelmchartpropspropertyrelease) | \`string\` | The name of the release. | -| [\`repository\`](#awscdklibawsekshelmchartpropspropertyrepository) | \`string\` | The repository which contains the chart. | -| [\`timeout\`](#awscdklibawsekshelmchartpropspropertytimeout) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | Amount of time to wait for any individual Kubernetes operation. | -| [\`values\`](#awscdklibawsekshelmchartpropspropertyvalues) | {[ key: string ]: \`any\`} | The values to be used by the chart. | -| [\`version\`](#awscdklibawsekshelmchartpropspropertyversion) | \`string\` | The chart version to install. | -| [\`wait\`](#awscdklibawsekshelmchartpropspropertywait) | \`boolean\` | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | -| [\`cluster\`](#awscdklibawsekshelmchartpropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | The EKS cluster to apply this configuration to. | +| chart | string | The name of the chart. | +| createNamespace | boolean | create namespace if not exist. | +| namespace | string | The Kubernetes namespace scope of the requests. | +| release | string | The name of the release. | +| repository | string | The repository which contains the chart. | +| timeout | aws-cdk-lib.Duration | Amount of time to wait for any individual Kubernetes operation. | +| values | {[ key: string ]: any} | The values to be used by the chart. | +| version | string | The chart version to install. | +| wait | boolean | Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | +| cluster | ICluster | The EKS cluster to apply this configuration to. | --- -##### \`chart\`Required +##### \`chart\`Required \`\`\`typescript public readonly chart: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the chart. --- -##### \`createNamespace\`Optional +##### \`createNamespace\`Optional \`\`\`typescript public readonly createNamespace: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true create namespace if not exist. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* default The Kubernetes namespace scope of the requests. --- -##### \`release\`Optional +##### \`release\`Optional \`\`\`typescript public readonly release: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no release name is given, it will use the last 53 characters of the node's unique id. The name of the release. --- -##### \`repository\`Optional +##### \`repository\`Optional \`\`\`typescript public readonly repository: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* No repository will be used, which means that the chart needs to be an absolute URL. The repository which contains the chart. @@ -88417,13 +90601,13 @@ For example: https://kubernetes-charts.storage.googleapis.com/ --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`typescript public readonly timeout: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) Amount of time to wait for any individual Kubernetes operation. @@ -88432,52 +90616,52 @@ Maximum 15 minutes. --- -##### \`values\`Optional +##### \`values\`Optional \`\`\`typescript public readonly values: {[ key: string ]: any}; \`\`\` -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} - *Default:* No values are provided to the chart. The values to be used by the chart. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If this is not specified, the latest version is installed The chart version to install. --- -##### \`wait\`Optional +##### \`wait\`Optional \`\`\`typescript public readonly wait: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* Helm will not wait before marking release as successful Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this configuration to. @@ -88485,11 +90669,11 @@ The EKS cluster to apply this configuration to. --- -### KubernetesManifestOptions +### KubernetesManifestOptions Options for \`KubernetesManifest\`. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88497,50 +90681,50 @@ import { aws_eks } from 'aws-cdk-lib' const kubernetesManifestOptions: aws_eks.KubernetesManifestOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#awscdklibawsekskubernetesmanifestoptionspropertyprune) | \`boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#awscdklibawsekskubernetesmanifestoptionspropertyskipvalidation) | \`boolean\` | A flag to signify if the manifest validation should be skipped. | +| prune | boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | boolean | A flag to signify if the manifest validation should be skipped. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`typescript public readonly skipValidation: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -### KubernetesManifestProps +### KubernetesManifestProps Properties for KubernetesManifest. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88548,55 +90732,55 @@ import { aws_eks } from 'aws-cdk-lib' const kubernetesManifestProps: aws_eks.KubernetesManifestProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`prune\`](#awscdklibawsekskubernetesmanifestpropspropertyprune) | \`boolean\` | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | -| [\`skipValidation\`](#awscdklibawsekskubernetesmanifestpropspropertyskipvalidation) | \`boolean\` | A flag to signify if the manifest validation should be skipped. | -| [\`cluster\`](#awscdklibawsekskubernetesmanifestpropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | The EKS cluster to apply this manifest to. | -| [\`manifest\`](#awscdklibawsekskubernetesmanifestpropspropertymanifest)* | {[ key: string ]: \`any\`}[] | The manifest to apply. | -| [\`overwrite\`](#awscdklibawsekskubernetesmanifestpropspropertyoverwrite) | \`boolean\` | Overwrite any existing resources. | +| prune | boolean | When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. | +| skipValidation | boolean | A flag to signify if the manifest validation should be skipped. | +| cluster | ICluster | The EKS cluster to apply this manifest to. | +| manifest | {[ key: string ]: any}[] | The manifest to apply. | +| overwrite | boolean | Overwrite any existing resources. | --- -##### \`prune\`Optional +##### \`prune\`Optional \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* based on the prune option of the cluster, which is \`true\` unless otherwise specified. When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted. To address this, \`kubectl apply\` has a \`--prune\` option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become \\"orphaned\\" and will not be deleted from the cluster. When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via \`kubectl apply --prune\`. The label name will be \`aws.cdk.eks/prune-\` where \`\` is the 42-char unique address of this construct in the construct tree. Value is empty. -> https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label +> [https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label) --- -##### \`skipValidation\`Optional +##### \`skipValidation\`Optional \`\`\`typescript public readonly skipValidation: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false A flag to signify if the manifest validation should be skipped. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to apply this manifest to. @@ -88604,13 +90788,13 @@ The EKS cluster to apply this manifest to. --- -##### \`manifest\`Required +##### \`manifest\`Required \`\`\`typescript public readonly manifest: {[ key: string ]: any}[]; \`\`\` -- *Type:* {[ key: string ]: \`any\`}[] +- *Type:* {[ key: string ]: any}[] The manifest to apply. @@ -88618,13 +90802,13 @@ Consists of any number of child resources. When the resources are created/updat --- -##### \`overwrite\`Optional +##### \`overwrite\`Optional \`\`\`typescript public readonly overwrite: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* false Overwrite any existing resources. @@ -88633,11 +90817,11 @@ If this is set, we will use \`kubectl apply\` instead of \`kubectl create\` when --- -### KubernetesNetworkConfigProperty +### KubernetesNetworkConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88645,21 +90829,21 @@ import { aws_eks } from 'aws-cdk-lib' const kubernetesNetworkConfigProperty: aws_eks.CfnCluster.KubernetesNetworkConfigProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`serviceIpv4Cidr\`](#awscdklibawsekscfnclusterkubernetesnetworkconfigpropertypropertyserviceipv4cidr) | \`string\` | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | +| serviceIpv4Cidr | string | \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. | --- -##### \`serviceIpv4Cidr\`Optional +##### \`serviceIpv4Cidr\`Optional \`\`\`typescript public readonly serviceIpv4Cidr: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr\`. @@ -88667,11 +90851,11 @@ public readonly serviceIpv4Cidr: string; --- -### KubernetesObjectValueProps +### KubernetesObjectValueProps Properties for KubernetesObjectValue. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88679,26 +90863,26 @@ import { aws_eks } from 'aws-cdk-lib' const kubernetesObjectValueProps: aws_eks.KubernetesObjectValueProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`cluster\`](#awscdklibawsekskubernetesobjectvaluepropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | The EKS cluster to fetch attributes from. | -| [\`jsonPath\`](#awscdklibawsekskubernetesobjectvaluepropspropertyjsonpath)* | \`string\` | JSONPath to the specific value. | -| [\`objectName\`](#awscdklibawsekskubernetesobjectvaluepropspropertyobjectname)* | \`string\` | The name of the object to query. | -| [\`objectType\`](#awscdklibawsekskubernetesobjectvaluepropspropertyobjecttype)* | \`string\` | The object type to query. | -| [\`objectNamespace\`](#awscdklibawsekskubernetesobjectvaluepropspropertyobjectnamespace) | \`string\` | The namespace the object belongs to. | -| [\`timeout\`](#awscdklibawsekskubernetesobjectvaluepropspropertytimeout) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | Timeout for waiting on a value. | +| cluster | ICluster | The EKS cluster to fetch attributes from. | +| jsonPath | string | JSONPath to the specific value. | +| objectName | string | The name of the object to query. | +| objectType | string | The object type to query. | +| objectNamespace | string | The namespace the object belongs to. | +| timeout | aws-cdk-lib.Duration | Timeout for waiting on a value. | --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster The EKS cluster to fetch attributes from. @@ -88706,39 +90890,39 @@ The EKS cluster to fetch attributes from. --- -##### \`jsonPath\`Required +##### \`jsonPath\`Required \`\`\`typescript public readonly jsonPath: string; \`\`\` -- *Type:* \`string\` +- *Type:* string JSONPath to the specific value. -> https://kubernetes.io/docs/reference/kubectl/jsonpath/ +> [https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/) --- -##### \`objectName\`Required +##### \`objectName\`Required \`\`\`typescript public readonly objectName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the object to query. --- -##### \`objectType\`Required +##### \`objectType\`Required \`\`\`typescript public readonly objectType: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The object type to query. @@ -88746,37 +90930,37 @@ The object type to query. --- -##### \`objectNamespace\`Optional +##### \`objectNamespace\`Optional \`\`\`typescript public readonly objectNamespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the object belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`typescript public readonly timeout: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) Timeout for waiting on a value. --- -### KubernetesPatchProps +### KubernetesPatchProps Properties for KubernetesPatch. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88784,38 +90968,38 @@ import { aws_eks } from 'aws-cdk-lib' const kubernetesPatchProps: aws_eks.KubernetesPatchProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`applyPatch\`](#awscdklibawsekskubernetespatchpropspropertyapplypatch)* | {[ key: string ]: \`any\`} | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | -| [\`cluster\`](#awscdklibawsekskubernetespatchpropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | The cluster to apply the patch to. | -| [\`resourceName\`](#awscdklibawsekskubernetespatchpropspropertyresourcename)* | \`string\` | The full name of the resource to patch (e.g. \`deployment/coredns\`). | -| [\`restorePatch\`](#awscdklibawsekskubernetespatchpropspropertyrestorepatch)* | {[ key: string ]: \`any\`} | The JSON object to pass to \`kubectl patch\` when the resource is removed. | -| [\`patchType\`](#awscdklibawsekskubernetespatchpropspropertypatchtype) | [\`aws-cdk-lib.aws_eks.PatchType\`](#aws-cdk-lib.aws_eks.PatchType) | The patch type to pass to \`kubectl patch\`. | -| [\`resourceNamespace\`](#awscdklibawsekskubernetespatchpropspropertyresourcenamespace) | \`string\` | The kubernetes API namespace. | +| applyPatch | {[ key: string ]: any} | The JSON object to pass to \`kubectl patch\` when the resource is created/updated. | +| cluster | ICluster | The cluster to apply the patch to. | +| resourceName | string | The full name of the resource to patch (e.g. \`deployment/coredns\`). | +| restorePatch | {[ key: string ]: any} | The JSON object to pass to \`kubectl patch\` when the resource is removed. | +| patchType | PatchType | The patch type to pass to \`kubectl patch\`. | +| resourceNamespace | string | The kubernetes API namespace. | --- -##### \`applyPatch\`Required +##### \`applyPatch\`Required \`\`\`typescript public readonly applyPatch: {[ key: string ]: any}; \`\`\` -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} The JSON object to pass to \`kubectl patch\` when the resource is created/updated. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. @@ -88823,37 +91007,37 @@ The cluster to apply the patch to. --- -##### \`resourceName\`Required +##### \`resourceName\`Required \`\`\`typescript public readonly resourceName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The full name of the resource to patch (e.g. \`deployment/coredns\`). --- -##### \`restorePatch\`Required +##### \`restorePatch\`Required \`\`\`typescript public readonly restorePatch: {[ key: string ]: any}; \`\`\` -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} The JSON object to pass to \`kubectl patch\` when the resource is removed. --- -##### \`patchType\`Optional +##### \`patchType\`Optional \`\`\`typescript public readonly patchType: PatchType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.PatchType\`](#aws-cdk-lib.aws_eks.PatchType) +- *Type:* PatchType - *Default:* PatchType.STRATEGIC The patch type to pass to \`kubectl patch\`. @@ -88862,24 +91046,24 @@ The default type used by \`kubectl patch\` is \\"strategic\\". --- -##### \`resourceNamespace\`Optional +##### \`resourceNamespace\`Optional \`\`\`typescript public readonly resourceNamespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The kubernetes API namespace. --- -### LabelProperty +### LabelProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-label.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88887,22 +91071,22 @@ import { aws_eks } from 'aws-cdk-lib' const labelProperty: aws_eks.CfnFargateProfile.LabelProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`key\`](#awscdklibawsekscfnfargateprofilelabelpropertypropertykey)* | \`string\` | \`CfnFargateProfile.LabelProperty.Key\`. | -| [\`value\`](#awscdklibawsekscfnfargateprofilelabelpropertypropertyvalue)* | \`string\` | \`CfnFargateProfile.LabelProperty.Value\`. | +| key | string | \`CfnFargateProfile.LabelProperty.Key\`. | +| value | string | \`CfnFargateProfile.LabelProperty.Value\`. | --- -##### \`key\`Required +##### \`key\`Required \`\`\`typescript public readonly key: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Key\`. @@ -88910,13 +91094,13 @@ public readonly key: string; --- -##### \`value\`Required +##### \`value\`Required \`\`\`typescript public readonly value: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.LabelProperty.Value\`. @@ -88924,11 +91108,11 @@ public readonly value: string; --- -### LaunchTemplateSpec +### LaunchTemplateSpec Launch template property specification. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88936,45 +91120,45 @@ import { aws_eks } from 'aws-cdk-lib' const launchTemplateSpec: aws_eks.LaunchTemplateSpec = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#awscdklibawsekslaunchtemplatespecpropertyid)* | \`string\` | The Launch template ID. | -| [\`version\`](#awscdklibawsekslaunchtemplatespecpropertyversion) | \`string\` | The launch template version to be used (optional). | +| id | string | The Launch template ID. | +| version | string | The launch template version to be used (optional). | --- -##### \`id\`Required +##### \`id\`Required \`\`\`typescript public readonly id: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The Launch template ID. --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* the default version of the launch template The launch template version to be used (optional). --- -### LaunchTemplateSpecificationProperty +### LaunchTemplateSpecificationProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -88982,23 +91166,23 @@ import { aws_eks } from 'aws-cdk-lib' const launchTemplateSpecificationProperty: aws_eks.CfnNodegroup.LaunchTemplateSpecificationProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`id\`](#awscdklibawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyid) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | -| [\`name\`](#awscdklibawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyname) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | -| [\`version\`](#awscdklibawsekscfnnodegrouplaunchtemplatespecificationpropertypropertyversion) | \`string\` | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | +| id | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. | +| name | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. | +| version | string | \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. | --- -##### \`id\`Optional +##### \`id\`Optional \`\`\`typescript public readonly id: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Id\`. @@ -89006,13 +91190,13 @@ public readonly id: string; --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`typescript public readonly name: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Name\`. @@ -89020,13 +91204,13 @@ public readonly name: string; --- -##### \`version\`Optional +##### \`version\`Optional \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.LaunchTemplateSpecificationProperty.Version\`. @@ -89034,11 +91218,11 @@ public readonly version: string; --- -### NodegroupOptions +### NodegroupOptions The Nodegroup Options for addNodeGroup() method. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89046,62 +91230,62 @@ import { aws_eks } from 'aws-cdk-lib' const nodegroupOptions: aws_eks.NodegroupOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#awscdklibawseksnodegroupoptionspropertyamitype) | [\`aws-cdk-lib.aws_eks.NodegroupAmiType\`](#aws-cdk-lib.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#awscdklibawseksnodegroupoptionspropertycapacitytype) | [\`aws-cdk-lib.aws_eks.CapacityType\`](#aws-cdk-lib.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#awscdklibawseksnodegroupoptionspropertydesiredsize) | \`number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#awscdklibawseksnodegroupoptionspropertydisksize) | \`number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#awscdklibawseksnodegroupoptionspropertyforceupdate) | \`boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceTypes\`](#awscdklibawseksnodegroupoptionspropertyinstancetypes) | [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`labels\`](#awscdklibawseksnodegroupoptionspropertylabels) | {[ key: string ]: \`string\`} | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#awscdklibawseksnodegroupoptionspropertylaunchtemplatespec) | [\`aws-cdk-lib.aws_eks.LaunchTemplateSpec\`](#aws-cdk-lib.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#awscdklibawseksnodegroupoptionspropertymaxsize) | \`number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#awscdklibawseksnodegroupoptionspropertyminsize) | \`number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#awscdklibawseksnodegroupoptionspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`nodeRole\`](#awscdklibawseksnodegroupoptionspropertynoderole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#awscdklibawseksnodegroupoptionspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#awscdklibawseksnodegroupoptionspropertyremoteaccess) | [\`aws-cdk-lib.aws_eks.NodegroupRemoteAccess\`](#aws-cdk-lib.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#awscdklibawseksnodegroupoptionspropertysubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#awscdklibawseksnodegroupoptionspropertytags) | {[ key: string ]: \`string\`} | The metadata to apply to the node group to assist with categorization and organization. | +| amiType | NodegroupAmiType | The AMI type for your node group. | +| capacityType | CapacityType | The capacity type of the nodegroup. | +| desiredSize | number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceTypes | aws-cdk-lib.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| labels | {[ key: string ]: string} | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | string | Name of the Nodegroup. | +| nodeRole | aws-cdk-lib.aws_iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | aws-cdk-lib.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | {[ key: string ]: string} | The metadata to apply to the node group to assist with categorization and organization. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`typescript public readonly amiType: NodegroupAmiType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupAmiType\`](#aws-cdk-lib.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`typescript public readonly capacityType: CapacityType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CapacityType\`](#aws-cdk-lib.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`typescript public readonly desiredSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -89110,26 +91294,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`typescript public readonly diskSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`typescript public readonly forceUpdate: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -89138,56 +91322,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`typescript public readonly instanceTypes: InstanceType[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType)[] +- *Type:* aws-cdk-lib.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`typescript public readonly labels: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`typescript public readonly launchTemplateSpec: LaunchTemplateSpec; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.LaunchTemplateSpec\`](#aws-cdk-lib.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`typescript public readonly maxSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -89196,13 +91380,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`typescript public readonly minSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -89211,26 +91395,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`typescript public readonly nodeRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -89239,26 +91423,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`typescript public readonly releaseVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`typescript public readonly remoteAccess: NodegroupRemoteAccess; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupRemoteAccess\`](#aws-cdk-lib.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -89267,13 +91451,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`typescript public readonly subnets: SubnetSelection; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -89282,13 +91466,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -89297,11 +91481,11 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -### NodegroupProps +### NodegroupProps NodeGroup properties interface. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89309,63 +91493,63 @@ import { aws_eks } from 'aws-cdk-lib' const nodegroupProps: aws_eks.NodegroupProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`amiType\`](#awscdklibawseksnodegrouppropspropertyamitype) | [\`aws-cdk-lib.aws_eks.NodegroupAmiType\`](#aws-cdk-lib.aws_eks.NodegroupAmiType) | The AMI type for your node group. | -| [\`capacityType\`](#awscdklibawseksnodegrouppropspropertycapacitytype) | [\`aws-cdk-lib.aws_eks.CapacityType\`](#aws-cdk-lib.aws_eks.CapacityType) | The capacity type of the nodegroup. | -| [\`desiredSize\`](#awscdklibawseksnodegrouppropspropertydesiredsize) | \`number\` | The current number of worker nodes that the managed node group should maintain. | -| [\`diskSize\`](#awscdklibawseksnodegrouppropspropertydisksize) | \`number\` | The root device disk size (in GiB) for your node group instances. | -| [\`forceUpdate\`](#awscdklibawseksnodegrouppropspropertyforceupdate) | \`boolean\` | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | -| [\`instanceTypes\`](#awscdklibawseksnodegrouppropspropertyinstancetypes) | [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType)[] | The instance types to use for your node group. | -| [\`labels\`](#awscdklibawseksnodegrouppropspropertylabels) | {[ key: string ]: \`string\`} | The Kubernetes labels to be applied to the nodes in the node group when they are created. | -| [\`launchTemplateSpec\`](#awscdklibawseksnodegrouppropspropertylaunchtemplatespec) | [\`aws-cdk-lib.aws_eks.LaunchTemplateSpec\`](#aws-cdk-lib.aws_eks.LaunchTemplateSpec) | Launch template specification used for the nodegroup. | -| [\`maxSize\`](#awscdklibawseksnodegrouppropspropertymaxsize) | \`number\` | The maximum number of worker nodes that the managed node group can scale out to. | -| [\`minSize\`](#awscdklibawseksnodegrouppropspropertyminsize) | \`number\` | The minimum number of worker nodes that the managed node group can scale in to. | -| [\`nodegroupName\`](#awscdklibawseksnodegrouppropspropertynodegroupname) | \`string\` | Name of the Nodegroup. | -| [\`nodeRole\`](#awscdklibawseksnodegrouppropspropertynoderole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | The IAM role to associate with your node group. | -| [\`releaseVersion\`](#awscdklibawseksnodegrouppropspropertyreleaseversion) | \`string\` | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | -| [\`remoteAccess\`](#awscdklibawseksnodegrouppropspropertyremoteaccess) | [\`aws-cdk-lib.aws_eks.NodegroupRemoteAccess\`](#aws-cdk-lib.aws_eks.NodegroupRemoteAccess) | The remote access (SSH) configuration to use with your node group. | -| [\`subnets\`](#awscdklibawseksnodegrouppropspropertysubnets) | [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) | The subnets to use for the Auto Scaling group that is created for your node group. | -| [\`tags\`](#awscdklibawseksnodegrouppropspropertytags) | {[ key: string ]: \`string\`} | The metadata to apply to the node group to assist with categorization and organization. | -| [\`cluster\`](#awscdklibawseksnodegrouppropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | Cluster resource. | +| amiType | NodegroupAmiType | The AMI type for your node group. | +| capacityType | CapacityType | The capacity type of the nodegroup. | +| desiredSize | number | The current number of worker nodes that the managed node group should maintain. | +| diskSize | number | The root device disk size (in GiB) for your node group instances. | +| forceUpdate | boolean | Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. | +| instanceTypes | aws-cdk-lib.aws_ec2.InstanceType[] | The instance types to use for your node group. | +| labels | {[ key: string ]: string} | The Kubernetes labels to be applied to the nodes in the node group when they are created. | +| launchTemplateSpec | LaunchTemplateSpec | Launch template specification used for the nodegroup. | +| maxSize | number | The maximum number of worker nodes that the managed node group can scale out to. | +| minSize | number | The minimum number of worker nodes that the managed node group can scale in to. | +| nodegroupName | string | Name of the Nodegroup. | +| nodeRole | aws-cdk-lib.aws_iam.IRole | The IAM role to associate with your node group. | +| releaseVersion | string | The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). | +| remoteAccess | NodegroupRemoteAccess | The remote access (SSH) configuration to use with your node group. | +| subnets | aws-cdk-lib.aws_ec2.SubnetSelection | The subnets to use for the Auto Scaling group that is created for your node group. | +| tags | {[ key: string ]: string} | The metadata to apply to the node group to assist with categorization and organization. | +| cluster | ICluster | Cluster resource. | --- -##### \`amiType\`Optional +##### \`amiType\`Optional \`\`\`typescript public readonly amiType: NodegroupAmiType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupAmiType\`](#aws-cdk-lib.aws_eks.NodegroupAmiType) +- *Type:* NodegroupAmiType - *Default:* auto-determined from the instanceTypes property. The AMI type for your node group. --- -##### \`capacityType\`Optional +##### \`capacityType\`Optional \`\`\`typescript public readonly capacityType: CapacityType; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.CapacityType\`](#aws-cdk-lib.aws_eks.CapacityType) +- *Type:* CapacityType - *Default:* ON_DEMAND The capacity type of the nodegroup. --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`typescript public readonly desiredSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 2 The current number of worker nodes that the managed node group should maintain. @@ -89374,26 +91558,26 @@ If not specified, the nodewgroup will initially create \`minSize\` instances. --- -##### \`diskSize\`Optional +##### \`diskSize\`Optional \`\`\`typescript public readonly diskSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 20 The root device disk size (in GiB) for your node group instances. --- -##### \`forceUpdate\`Optional +##### \`forceUpdate\`Optional \`\`\`typescript public readonly forceUpdate: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean - *Default:* true Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. @@ -89402,56 +91586,56 @@ If an update fails because pods could not be drained, you can force the update a --- -##### \`instanceTypes\`Optional +##### \`instanceTypes\`Optional \`\`\`typescript public readonly instanceTypes: InstanceType[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.InstanceType\`](#aws-cdk-lib.aws_ec2.InstanceType)[] +- *Type:* aws-cdk-lib.aws_ec2.InstanceType[] - *Default:* t3.medium will be used according to the cloudformation document. The instance types to use for your node group. -> - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes +> [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes) --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`typescript public readonly labels: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* None The Kubernetes labels to be applied to the nodes in the node group when they are created. --- -##### \`launchTemplateSpec\`Optional +##### \`launchTemplateSpec\`Optional \`\`\`typescript public readonly launchTemplateSpec: LaunchTemplateSpec; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.LaunchTemplateSpec\`](#aws-cdk-lib.aws_eks.LaunchTemplateSpec) +- *Type:* LaunchTemplateSpec - *Default:* no launch template Launch template specification used for the nodegroup. -> - https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +> [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`typescript public readonly maxSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* desiredSize The maximum number of worker nodes that the managed node group can scale out to. @@ -89460,13 +91644,13 @@ Managed node groups can support up to 100 nodes by default. --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`typescript public readonly minSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number - *Default:* 1 The minimum number of worker nodes that the managed node group can scale in to. @@ -89475,26 +91659,26 @@ This number must be greater than zero. --- -##### \`nodegroupName\`Optional +##### \`nodegroupName\`Optional \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* resource ID Name of the Nodegroup. --- -##### \`nodeRole\`Optional +##### \`nodeRole\`Optional \`\`\`typescript public readonly nodeRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* None. Auto-generated if not specified. The IAM role to associate with your node group. @@ -89503,26 +91687,26 @@ The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf --- -##### \`releaseVersion\`Optional +##### \`releaseVersion\`Optional \`\`\`typescript public readonly releaseVersion: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* The latest available AMI version for the node group's current Kubernetes version is used. The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, \`1.14.7-YYYYMMDD\`). --- -##### \`remoteAccess\`Optional +##### \`remoteAccess\`Optional \`\`\`typescript public readonly remoteAccess: NodegroupRemoteAccess; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.NodegroupRemoteAccess\`](#aws-cdk-lib.aws_eks.NodegroupRemoteAccess) +- *Type:* NodegroupRemoteAccess - *Default:* disabled The remote access (SSH) configuration to use with your node group. @@ -89531,13 +91715,13 @@ Disabled by default, however, if you specify an Amazon EC2 SSH key but do not sp --- -##### \`subnets\`Optional +##### \`subnets\`Optional \`\`\`typescript public readonly subnets: SubnetSelection; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.SubnetSelection\`](#aws-cdk-lib.aws_ec2.SubnetSelection) +- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* private subnets The subnets to use for the Auto Scaling group that is created for your node group. @@ -89546,13 +91730,13 @@ By specifying the SubnetSelection, the selected subnets will automatically apply --- -##### \`tags\`Optional +##### \`tags\`Optional \`\`\`typescript public readonly tags: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* None The metadata to apply to the node group to assist with categorization and organization. @@ -89561,25 +91745,25 @@ Each tag consists of a key and an optional value, both of which you define. Node --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster Cluster resource. --- -### NodegroupRemoteAccess +### NodegroupRemoteAccess The remote access (SSH) configuration to use with your node group. -> https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html +> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89587,34 +91771,34 @@ import { aws_eks } from 'aws-cdk-lib' const nodegroupRemoteAccess: aws_eks.NodegroupRemoteAccess = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`sshKeyName\`](#awscdklibawseksnodegroupremoteaccesspropertysshkeyname)* | \`string\` | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | -| [\`sourceSecurityGroups\`](#awscdklibawseksnodegroupremoteaccesspropertysourcesecuritygroups) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup)[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | +| sshKeyName | string | The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. | +| sourceSecurityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The security groups that are allowed SSH access (port 22) to the worker nodes. | --- -##### \`sshKeyName\`Required +##### \`sshKeyName\`Required \`\`\`typescript public readonly sshKeyName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`typescript public readonly sourceSecurityGroups: ISecurityGroup[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup)[] +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* port 22 on the worker nodes is opened to the internet (0.0.0.0/0) The security groups that are allowed SSH access (port 22) to the worker nodes. @@ -89623,11 +91807,11 @@ If you specify an Amazon EC2 SSH key but do not specify a source security group --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Initialization properties for \`OpenIdConnectProvider\`. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89635,21 +91819,21 @@ import { aws_eks } from 'aws-cdk-lib' const openIdConnectProviderProps: aws_eks.OpenIdConnectProviderProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`url\`](#awscdklibawseksopenidconnectproviderpropspropertyurl)* | \`string\` | The URL of the identity provider. | +| url | string | The URL of the identity provider. | --- -##### \`url\`Required +##### \`url\`Required \`\`\`typescript public readonly url: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URL of the identity provider. @@ -89657,11 +91841,11 @@ The URL must begin with https:// and should correspond to the iss claim in the p --- -### ProviderProperty +### ProviderProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89669,21 +91853,21 @@ import { aws_eks } from 'aws-cdk-lib' const providerProperty: aws_eks.CfnCluster.ProviderProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`keyArn\`](#awscdklibawsekscfnclusterproviderpropertypropertykeyarn) | \`string\` | \`CfnCluster.ProviderProperty.KeyArn\`. | +| keyArn | string | \`CfnCluster.ProviderProperty.KeyArn\`. | --- -##### \`keyArn\`Optional +##### \`keyArn\`Optional \`\`\`typescript public readonly keyArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnCluster.ProviderProperty.KeyArn\`. @@ -89691,11 +91875,11 @@ public readonly keyArn: string; --- -### RemoteAccessProperty +### RemoteAccessProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89703,22 +91887,22 @@ import { aws_eks } from 'aws-cdk-lib' const remoteAccessProperty: aws_eks.CfnNodegroup.RemoteAccessProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`ec2SshKey\`](#awscdklibawsekscfnnodegroupremoteaccesspropertypropertyec2sshkey)* | \`string\` | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | -| [\`sourceSecurityGroups\`](#awscdklibawsekscfnnodegroupremoteaccesspropertypropertysourcesecuritygroups) | \`string\`[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | +| ec2SshKey | string | \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. | +| sourceSecurityGroups | string[] | \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. | --- -##### \`ec2SshKey\`Required +##### \`ec2SshKey\`Required \`\`\`typescript public readonly ec2SshKey: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.RemoteAccessProperty.Ec2SshKey\`. @@ -89726,13 +91910,13 @@ public readonly ec2SshKey: string; --- -##### \`sourceSecurityGroups\`Optional +##### \`sourceSecurityGroups\`Optional \`\`\`typescript public readonly sourceSecurityGroups: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnNodegroup.RemoteAccessProperty.SourceSecurityGroups\`. @@ -89740,11 +91924,11 @@ public readonly sourceSecurityGroups: string[]; --- -### ResourcesVpcConfigProperty +### ResourcesVpcConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89752,22 +91936,22 @@ import { aws_eks } from 'aws-cdk-lib' const resourcesVpcConfigProperty: aws_eks.CfnCluster.ResourcesVpcConfigProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`subnetIds\`](#awscdklibawsekscfnclusterresourcesvpcconfigpropertypropertysubnetids)* | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | -| [\`securityGroupIds\`](#awscdklibawsekscfnclusterresourcesvpcconfigpropertypropertysecuritygroupids) | \`string\`[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | +| subnetIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. | +| securityGroupIds | string[] | \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. | --- -##### \`subnetIds\`Required +##### \`subnetIds\`Required \`\`\`typescript public readonly subnetIds: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SubnetIds\`. @@ -89775,13 +91959,13 @@ public readonly subnetIds: string[]; --- -##### \`securityGroupIds\`Optional +##### \`securityGroupIds\`Optional \`\`\`typescript public readonly securityGroupIds: string[]; \`\`\` -- *Type:* \`string\`[] +- *Type:* string[] \`CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds\`. @@ -89789,11 +91973,11 @@ public readonly securityGroupIds: string[]; --- -### ScalingConfigProperty +### ScalingConfigProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89801,23 +91985,23 @@ import { aws_eks } from 'aws-cdk-lib' const scalingConfigProperty: aws_eks.CfnNodegroup.ScalingConfigProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`desiredSize\`](#awscdklibawsekscfnnodegroupscalingconfigpropertypropertydesiredsize) | \`number\` | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | -| [\`maxSize\`](#awscdklibawsekscfnnodegroupscalingconfigpropertypropertymaxsize) | \`number\` | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | -| [\`minSize\`](#awscdklibawsekscfnnodegroupscalingconfigpropertypropertyminsize) | \`number\` | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | +| desiredSize | number | \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. | +| maxSize | number | \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. | +| minSize | number | \`CfnNodegroup.ScalingConfigProperty.MinSize\`. | --- -##### \`desiredSize\`Optional +##### \`desiredSize\`Optional \`\`\`typescript public readonly desiredSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number \`CfnNodegroup.ScalingConfigProperty.DesiredSize\`. @@ -89825,13 +92009,13 @@ public readonly desiredSize: number; --- -##### \`maxSize\`Optional +##### \`maxSize\`Optional \`\`\`typescript public readonly maxSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number \`CfnNodegroup.ScalingConfigProperty.MaxSize\`. @@ -89839,13 +92023,13 @@ public readonly maxSize: number; --- -##### \`minSize\`Optional +##### \`minSize\`Optional \`\`\`typescript public readonly minSize: number; \`\`\` -- *Type:* \`number\` +- *Type:* number \`CfnNodegroup.ScalingConfigProperty.MinSize\`. @@ -89853,11 +92037,11 @@ public readonly minSize: number; --- -### Selector +### Selector Fargate profile selector. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89865,22 +92049,22 @@ import { aws_eks } from 'aws-cdk-lib' const selector: aws_eks.Selector = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdklibawseksselectorpropertynamespace)* | \`string\` | The Kubernetes namespace that the selector should match. | -| [\`labels\`](#awscdklibawseksselectorpropertylabels) | {[ key: string ]: \`string\`} | The Kubernetes labels that the selector should match. | +| namespace | string | The Kubernetes namespace that the selector should match. | +| labels | {[ key: string ]: string} | The Kubernetes labels that the selector should match. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The Kubernetes namespace that the selector should match. @@ -89888,13 +92072,13 @@ You must specify a namespace for a selector. The selector only matches pods that --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`typescript public readonly labels: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} - *Default:* all pods within the namespace will be selected. The Kubernetes labels that the selector should match. @@ -89903,11 +92087,11 @@ A pod must contain all of the labels that are specified in the selector for it t --- -### SelectorProperty +### SelectorProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-fargateprofile-selector.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89915,22 +92099,22 @@ import { aws_eks } from 'aws-cdk-lib' const selectorProperty: aws_eks.CfnFargateProfile.SelectorProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdklibawsekscfnfargateprofileselectorpropertypropertynamespace)* | \`string\` | \`CfnFargateProfile.SelectorProperty.Namespace\`. | -| [\`labels\`](#awscdklibawsekscfnfargateprofileselectorpropertypropertylabels) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) \\\\| [\`aws-cdk-lib.aws_eks.CfnFargateProfile.LabelProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.LabelProperty) \\\\| [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] | \`CfnFargateProfile.SelectorProperty.Labels\`. | +| namespace | string | \`CfnFargateProfile.SelectorProperty.Namespace\`. | +| labels | aws-cdk-lib.IResolvable \\\\| LabelProperty \\\\| aws-cdk-lib.IResolvable[] | \`CfnFargateProfile.SelectorProperty.Labels\`. | --- -##### \`namespace\`Required +##### \`namespace\`Required \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnFargateProfile.SelectorProperty.Namespace\`. @@ -89938,13 +92122,13 @@ public readonly namespace: string; --- -##### \`labels\`Optional +##### \`labels\`Optional \`\`\`typescript public readonly labels: IResolvable | LabelProperty | IResolvable[]; \`\`\` -- *Type:* [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable) | [\`aws-cdk-lib.aws_eks.CfnFargateProfile.LabelProperty\`](#aws-cdk-lib.aws_eks.CfnFargateProfile.LabelProperty) | [\`aws-cdk-lib.IResolvable\`](#aws-cdk-lib.IResolvable)[] +- *Type:* aws-cdk-lib.IResolvable | LabelProperty | aws-cdk-lib.IResolvable[] \`CfnFargateProfile.SelectorProperty.Labels\`. @@ -89952,11 +92136,11 @@ public readonly labels: IResolvable | LabelProperty | IResolvable[]; --- -### ServiceAccountOptions +### ServiceAccountOptions Options for \`ServiceAccount\`. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -89964,46 +92148,46 @@ import { aws_eks } from 'aws-cdk-lib' const serviceAccountOptions: aws_eks.ServiceAccountOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#awscdklibawseksserviceaccountoptionspropertyname) | \`string\` | The name of the service account. | -| [\`namespace\`](#awscdklibawseksserviceaccountoptionspropertynamespace) | \`string\` | The namespace of the service account. | +| name | string | The name of the service account. | +| namespace | string | The namespace of the service account. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`typescript public readonly name: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -### ServiceAccountProps +### ServiceAccountProps Properties for defining service accounts. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -90011,59 +92195,59 @@ import { aws_eks } from 'aws-cdk-lib' const serviceAccountProps: aws_eks.ServiceAccountProps = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`name\`](#awscdklibawseksserviceaccountpropspropertyname) | \`string\` | The name of the service account. | -| [\`namespace\`](#awscdklibawseksserviceaccountpropspropertynamespace) | \`string\` | The namespace of the service account. | -| [\`cluster\`](#awscdklibawseksserviceaccountpropspropertycluster)* | [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) | The cluster to apply the patch to. | +| name | string | The name of the service account. | +| namespace | string | The namespace of the service account. | +| cluster | ICluster | The cluster to apply the patch to. | --- -##### \`name\`Optional +##### \`name\`Optional \`\`\`typescript public readonly name: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* If no name is given, it will use the id of the resource. The name of the service account. --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* \\"default\\" The namespace of the service account. --- -##### \`cluster\`Required +##### \`cluster\`Required \`\`\`typescript public readonly cluster: ICluster; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Type:* ICluster The cluster to apply the patch to. --- -### ServiceLoadBalancerAddressOptions +### ServiceLoadBalancerAddressOptions Options for fetching a ServiceLoadBalancerAddress. -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -90071,46 +92255,46 @@ import { aws_eks } from 'aws-cdk-lib' const serviceLoadBalancerAddressOptions: aws_eks.ServiceLoadBalancerAddressOptions = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`namespace\`](#awscdklibawseksserviceloadbalanceraddressoptionspropertynamespace) | \`string\` | The namespace the service belongs to. | -| [\`timeout\`](#awscdklibawseksserviceloadbalanceraddressoptionspropertytimeout) | [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) | Timeout for waiting on the load balancer address. | +| namespace | string | The namespace the service belongs to. | +| timeout | aws-cdk-lib.Duration | Timeout for waiting on the load balancer address. | --- -##### \`namespace\`Optional +##### \`namespace\`Optional \`\`\`typescript public readonly namespace: string; \`\`\` -- *Type:* \`string\` +- *Type:* string - *Default:* 'default' The namespace the service belongs to. --- -##### \`timeout\`Optional +##### \`timeout\`Optional \`\`\`typescript public readonly timeout: Duration; \`\`\` -- *Type:* [\`aws-cdk-lib.Duration\`](#aws-cdk-lib.Duration) +- *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) Timeout for waiting on the load balancer address. --- -### TaintProperty +### TaintProperty > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) -#### Initializer +#### Initializer \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -90118,23 +92302,23 @@ import { aws_eks } from 'aws-cdk-lib' const taintProperty: aws_eks.CfnNodegroup.TaintProperty = { ... } \`\`\` -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`effect\`](#awscdklibawsekscfnnodegrouptaintpropertypropertyeffect) | \`string\` | \`CfnNodegroup.TaintProperty.Effect\`. | -| [\`key\`](#awscdklibawsekscfnnodegrouptaintpropertypropertykey) | \`string\` | \`CfnNodegroup.TaintProperty.Key\`. | -| [\`value\`](#awscdklibawsekscfnnodegrouptaintpropertypropertyvalue) | \`string\` | \`CfnNodegroup.TaintProperty.Value\`. | +| effect | string | \`CfnNodegroup.TaintProperty.Effect\`. | +| key | string | \`CfnNodegroup.TaintProperty.Key\`. | +| value | string | \`CfnNodegroup.TaintProperty.Value\`. | --- -##### \`effect\`Optional +##### \`effect\`Optional \`\`\`typescript public readonly effect: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Effect\`. @@ -90142,13 +92326,13 @@ public readonly effect: string; --- -##### \`key\`Optional +##### \`key\`Optional \`\`\`typescript public readonly key: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Key\`. @@ -90156,13 +92340,13 @@ public readonly key: string; --- -##### \`value\`Optional +##### \`value\`Optional \`\`\`typescript public readonly value: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`CfnNodegroup.TaintProperty.Value\`. @@ -90170,15 +92354,15 @@ public readonly value: string; --- -## Classes +## Classes -### EksOptimizedImage +### EksOptimizedImage -- *Implements:* [\`aws-cdk-lib.aws_ec2.IMachineImage\`](#aws-cdk-lib.aws_ec2.IMachineImage) +- *Implements:* aws-cdk-lib.aws_ec2.IMachineImage Construct an Amazon Linux 2 image from the latest EKS Optimized AMI published in SSM. -#### Initializers +#### Initializers \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -90188,60 +92372,60 @@ new aws_eks.EksOptimizedImage(props?: EksOptimizedImageProps) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`props\`](#awscdklibawsekseksoptimizedimageparameterprops) | [\`aws-cdk-lib.aws_eks.EksOptimizedImageProps\`](#aws-cdk-lib.aws_eks.EksOptimizedImageProps) | *No description.* | +| props | EksOptimizedImageProps | *No description.* | --- -##### \`props\`Optional +##### \`props\`Optional -- *Type:* [\`aws-cdk-lib.aws_eks.EksOptimizedImageProps\`](#aws-cdk-lib.aws_eks.EksOptimizedImageProps) +- *Type:* EksOptimizedImageProps --- -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`getImage\`](#awscdklibawsekseksoptimizedimagegetimage) | Return the correct image. | +| getImage | Return the correct image. | --- -##### \`getImage\` +##### \`getImage\` \`\`\`typescript public getImage(scope: Construct) \`\`\` -###### \`scope\`Required +###### \`scope\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct --- -### EndpointAccess +### EndpointAccess Endpoint access characteristics. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`onlyFrom\`](#awscdklibawseksendpointaccessonlyfrom) | Restrict public access to specific CIDR blocks. | +| onlyFrom | Restrict public access to specific CIDR blocks. | --- -##### \`onlyFrom\` +##### \`onlyFrom\` \`\`\`typescript public onlyFrom(cidr: string) \`\`\` -###### \`cidr\`Required +###### \`cidr\`Required -- *Type:* \`string\` +- *Type:* string CIDR blocks. @@ -90249,19 +92433,23 @@ CIDR blocks. -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`PRIVATE\`](#awscdklibawseksendpointaccesspropertyprivate)* | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | The cluster endpoint is only accessible through your VPC. | -| [\`PUBLIC\`](#awscdklibawseksendpointaccesspropertypublic)* | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | -| [\`PUBLIC_AND_PRIVATE\`](#awscdklibawseksendpointaccesspropertypublicandprivate)* | [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) | The cluster endpoint is accessible from outside of your VPC. | +| PRIVATE | EndpointAccess | The cluster endpoint is only accessible through your VPC. | +| PUBLIC | EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | +| PUBLIC_AND_PRIVATE | EndpointAccess | The cluster endpoint is accessible from outside of your VPC. | --- -##### \`PRIVATE\` +##### \`PRIVATE\`Required + +\`\`\`typescript +public readonly PRIVATE: EndpointAccess; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +- *Type:* EndpointAccess The cluster endpoint is only accessible through your VPC. @@ -90269,9 +92457,13 @@ Worker node traffic to the endpoint will stay within your VPC. --- -##### \`PUBLIC\` +##### \`PUBLIC\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +\`\`\`typescript +public readonly PUBLIC: EndpointAccess; +\`\`\` + +- *Type:* EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -90279,9 +92471,13 @@ Worker node traffic will leave your VPC to connect to the endpoint. By default, --- -##### \`PUBLIC_AND_PRIVATE\` +##### \`PUBLIC_AND_PRIVATE\`Required + +\`\`\`typescript +public readonly PUBLIC_AND_PRIVATE: EndpointAccess; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.EndpointAccess\`](#aws-cdk-lib.aws_eks.EndpointAccess) +- *Type:* EndpointAccess The cluster endpoint is accessible from outside of your VPC. @@ -90289,20 +92485,20 @@ Worker node traffic to the endpoint will stay within your VPC. By default, the --- -### KubernetesVersion +### KubernetesVersion Kubernetes cluster version. -#### Static Functions +#### Static Functions | **Name** | **Description** | | --- | --- | -| [\`of\`](#awscdklibawsekskubernetesversionof) | Custom cluster version. | +| of | Custom cluster version. | --- -##### \`of\` +##### \`of\` \`\`\`typescript import { aws_eks } from 'aws-cdk-lib' @@ -90310,250 +92506,274 @@ import { aws_eks } from 'aws-cdk-lib' aws_eks.KubernetesVersion.of(version: string) \`\`\` -###### \`version\`Required +###### \`version\`Required -- *Type:* \`string\` +- *Type:* string custom version number. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`version\`](#awscdklibawsekskubernetesversionpropertyversion)* | \`string\` | cluster version number. | +| version | string | cluster version number. | --- -##### \`version\`Required +##### \`version\`Required \`\`\`typescript public readonly version: string; \`\`\` -- *Type:* \`string\` +- *Type:* string cluster version number. --- -#### Constants +#### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`V1_14\`](#awscdklibawsekskubernetesversionpropertyv114)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.14. | -| [\`V1_15\`](#awscdklibawsekskubernetesversionpropertyv115)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.15. | -| [\`V1_16\`](#awscdklibawsekskubernetesversionpropertyv116)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.16. | -| [\`V1_17\`](#awscdklibawsekskubernetesversionpropertyv117)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.17. | -| [\`V1_18\`](#awscdklibawsekskubernetesversionpropertyv118)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.18. | -| [\`V1_19\`](#awscdklibawsekskubernetesversionpropertyv119)* | [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) | Kubernetes version 1.19. | +| V1_14 | KubernetesVersion | Kubernetes version 1.14. | +| V1_15 | KubernetesVersion | Kubernetes version 1.15. | +| V1_16 | KubernetesVersion | Kubernetes version 1.16. | +| V1_17 | KubernetesVersion | Kubernetes version 1.17. | +| V1_18 | KubernetesVersion | Kubernetes version 1.18. | +| V1_19 | KubernetesVersion | Kubernetes version 1.19. | --- -##### \`V1_14\` +##### \`V1_14\`Required + +\`\`\`typescript +public readonly V1_14: KubernetesVersion; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.14. --- -##### \`V1_15\` +##### \`V1_15\`Required + +\`\`\`typescript +public readonly V1_15: KubernetesVersion; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.15. --- -##### \`V1_16\` +##### \`V1_16\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +\`\`\`typescript +public readonly V1_16: KubernetesVersion; +\`\`\` + +- *Type:* KubernetesVersion Kubernetes version 1.16. --- -##### \`V1_17\` +##### \`V1_17\`Required + +\`\`\`typescript +public readonly V1_17: KubernetesVersion; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.17. --- -##### \`V1_18\` +##### \`V1_18\`Required + +\`\`\`typescript +public readonly V1_18: KubernetesVersion; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.18. --- -##### \`V1_19\` +##### \`V1_19\`Required + +\`\`\`typescript +public readonly V1_19: KubernetesVersion; +\`\`\` -- *Type:* [\`aws-cdk-lib.aws_eks.KubernetesVersion\`](#aws-cdk-lib.aws_eks.KubernetesVersion) +- *Type:* KubernetesVersion Kubernetes version 1.19. --- -## Protocols +## Protocols -### ICluster +### ICluster -- *Extends:* [\`aws-cdk-lib.IResource\`](#aws-cdk-lib.IResource), [\`aws-cdk-lib.aws_ec2.IConnectable\`](#aws-cdk-lib.aws_ec2.IConnectable) +- *Extends:* aws-cdk-lib.IResource, aws-cdk-lib.aws_ec2.IConnectable -- *Implemented By:* [\`aws-cdk-lib.aws_eks.Cluster\`](#aws-cdk-lib.aws_eks.Cluster), [\`aws-cdk-lib.aws_eks.FargateCluster\`](#aws-cdk-lib.aws_eks.FargateCluster), [\`aws-cdk-lib.aws_eks.ICluster\`](#aws-cdk-lib.aws_eks.ICluster) +- *Implemented By:* Cluster, FargateCluster, ICluster An EKS cluster. -#### Methods +#### Methods | **Name** | **Description** | | --- | --- | -| [\`addCdk8sChart\`](#awscdklibawseksiclusteraddcdk8schart) | Defines a CDK8s chart in this cluster. | -| [\`addHelmChart\`](#awscdklibawseksiclusteraddhelmchart) | Defines a Helm chart in this cluster. | -| [\`addManifest\`](#awscdklibawseksiclusteraddmanifest) | Defines a Kubernetes resource in this cluster. | -| [\`addServiceAccount\`](#awscdklibawseksiclusteraddserviceaccount) | Creates a new service account with corresponding IAM Role (IRSA). | +| addCdk8sChart | Defines a CDK8s chart in this cluster. | +| addHelmChart | Defines a Helm chart in this cluster. | +| addManifest | Defines a Kubernetes resource in this cluster. | +| addServiceAccount | Creates a new service account with corresponding IAM Role (IRSA). | --- -##### \`addCdk8sChart\` +##### \`addCdk8sChart\` \`\`\`typescript public addCdk8sChart(id: string, chart: Construct) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`chart\`Required +###### \`chart\`Required -- *Type:* [\`constructs.Construct\`](#constructs.Construct) +- *Type:* constructs.Construct the cdk8s chart. --- -##### \`addHelmChart\` +##### \`addHelmChart\` \`\`\`typescript public addHelmChart(id: string, options: HelmChartOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this chart. --- -###### \`options\`Required +###### \`options\`Required -- *Type:* [\`aws-cdk-lib.aws_eks.HelmChartOptions\`](#aws-cdk-lib.aws_eks.HelmChartOptions) +- *Type:* HelmChartOptions options of this chart. --- -##### \`addManifest\` +##### \`addManifest\` \`\`\`typescript public addManifest(id: string, manifest: {[ key: string ]: any}) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of this manifest. --- -###### \`manifest\`Required +###### \`manifest\`Required -- *Type:* {[ key: string ]: \`any\`} +- *Type:* {[ key: string ]: any} a list of Kubernetes resource specifications. --- -##### \`addServiceAccount\` +##### \`addServiceAccount\` \`\`\`typescript public addServiceAccount(id: string, options?: ServiceAccountOptions) \`\`\` -###### \`id\`Required +###### \`id\`Required -- *Type:* \`string\` +- *Type:* string logical id of service account. --- -###### \`options\`Optional +###### \`options\`Optional -- *Type:* [\`aws-cdk-lib.aws_eks.ServiceAccountOptions\`](#aws-cdk-lib.aws_eks.ServiceAccountOptions) +- *Type:* ServiceAccountOptions service account options. --- -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdklibawseksiclusterpropertynode)* | [\`constructs.Node\`](#constructs.Node) | The tree node. | -| [\`env\`](#awscdklibawseksiclusterpropertyenv)* | [\`aws-cdk-lib.ResourceEnvironment\`](#aws-cdk-lib.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdklibawseksiclusterpropertystack)* | [\`aws-cdk-lib.Stack\`](#aws-cdk-lib.Stack) | The stack in which this resource is defined. | -| [\`connections\`](#awscdklibawseksiclusterpropertyconnections)* | [\`aws-cdk-lib.aws_ec2.Connections\`](#aws-cdk-lib.aws_ec2.Connections) | *No description.* | -| [\`clusterArn\`](#awscdklibawseksiclusterpropertyclusterarn)* | \`string\` | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | -| [\`clusterCertificateAuthorityData\`](#awscdklibawseksiclusterpropertyclustercertificateauthoritydata)* | \`string\` | The certificate-authority-data for your cluster. | -| [\`clusterEncryptionConfigKeyArn\`](#awscdklibawseksiclusterpropertyclusterencryptionconfigkeyarn)* | \`string\` | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | -| [\`clusterEndpoint\`](#awscdklibawseksiclusterpropertyclusterendpoint)* | \`string\` | The API Server endpoint URL. | -| [\`clusterName\`](#awscdklibawseksiclusterpropertyclustername)* | \`string\` | The physical name of the Cluster. | -| [\`clusterSecurityGroup\`](#awscdklibawseksiclusterpropertyclustersecuritygroup)* | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | The cluster security group that was created by Amazon EKS for the cluster. | -| [\`clusterSecurityGroupId\`](#awscdklibawseksiclusterpropertyclustersecuritygroupid)* | \`string\` | The id of the cluster security group that was created by Amazon EKS for the cluster. | -| [\`openIdConnectProvider\`](#awscdklibawseksiclusterpropertyopenidconnectprovider)* | [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) | The Open ID Connect Provider of the cluster used to configure Service Accounts. | -| [\`prune\`](#awscdklibawseksiclusterpropertyprune)* | \`boolean\` | Indicates whether Kubernetes resources can be automatically pruned. | -| [\`vpc\`](#awscdklibawseksiclusterpropertyvpc)* | [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) | The VPC in which this Cluster was created. | -| [\`kubectlEnvironment\`](#awscdklibawseksiclusterpropertykubectlenvironment) | {[ key: string ]: \`string\`} | Custom environment variables when running \`kubectl\` against this cluster. | -| [\`kubectlLayer\`](#awscdklibawseksiclusterpropertykubectllayer) | [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | -| [\`kubectlMemory\`](#awscdklibawseksiclusterpropertykubectlmemory) | [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) | Amount of memory to allocate to the provider's lambda function. | -| [\`kubectlPrivateSubnets\`](#awscdklibawseksiclusterpropertykubectlprivatesubnets) | [\`aws-cdk-lib.aws_ec2.ISubnet\`](#aws-cdk-lib.aws_ec2.ISubnet)[] | Subnets to host the \`kubectl\` compute resources. | -| [\`kubectlRole\`](#awscdklibawseksiclusterpropertykubectlrole) | [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) | An IAM role that can perform kubectl operations against this cluster. | -| [\`kubectlSecurityGroup\`](#awscdklibawseksiclusterpropertykubectlsecuritygroup) | [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) | A security group to use for \`kubectl\` execution. | +| node | constructs.Node | The tree node. | +| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | +| connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | +| clusterArn | string | The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. | +| clusterCertificateAuthorityData | string | The certificate-authority-data for your cluster. | +| clusterEncryptionConfigKeyArn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). | +| clusterEndpoint | string | The API Server endpoint URL. | +| clusterName | string | The physical name of the Cluster. | +| clusterSecurityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | The cluster security group that was created by Amazon EKS for the cluster. | +| clusterSecurityGroupId | string | The id of the cluster security group that was created by Amazon EKS for the cluster. | +| openIdConnectProvider | aws-cdk-lib.aws_iam.IOpenIdConnectProvider | The Open ID Connect Provider of the cluster used to configure Service Accounts. | +| prune | boolean | Indicates whether Kubernetes resources can be automatically pruned. | +| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which this Cluster was created. | +| kubectlEnvironment | {[ key: string ]: string} | Custom environment variables when running \`kubectl\` against this cluster. | +| kubectlLayer | aws-cdk-lib.aws_lambda.ILayerVersion | An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. | +| kubectlMemory | aws-cdk-lib.Size | Amount of memory to allocate to the provider's lambda function. | +| kubectlPrivateSubnets | aws-cdk-lib.aws_ec2.ISubnet[] | Subnets to host the \`kubectl\` compute resources. | +| kubectlRole | aws-cdk-lib.aws_iam.IRole | An IAM role that can perform kubectl operations against this cluster. | +| kubectlSecurityGroup | aws-cdk-lib.aws_ec2.ISecurityGroup | A security group to use for \`kubectl\` execution. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`typescript public readonly node: Node; \`\`\` -- *Type:* [\`constructs.Node\`](#constructs.Node) +- *Type:* constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` -- *Type:* [\`aws-cdk-lib.ResourceEnvironment\`](#aws-cdk-lib.ResourceEnvironment) +- *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. @@ -90561,131 +92781,131 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`typescript public readonly stack: Stack; \`\`\` -- *Type:* [\`aws-cdk-lib.Stack\`](#aws-cdk-lib.Stack) +- *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- -##### \`connections\`Required +##### \`connections\`Required \`\`\`typescript public readonly connections: Connections; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.Connections\`](#aws-cdk-lib.aws_ec2.Connections) +- *Type:* aws-cdk-lib.aws_ec2.Connections --- -##### \`clusterArn\`Required +##### \`clusterArn\`Required \`\`\`typescript public readonly clusterArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The unique ARN assigned to the service by AWS in the form of arn:aws:eks:. --- -##### \`clusterCertificateAuthorityData\`Required +##### \`clusterCertificateAuthorityData\`Required \`\`\`typescript public readonly clusterCertificateAuthorityData: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The certificate-authority-data for your cluster. --- -##### \`clusterEncryptionConfigKeyArn\`Required +##### \`clusterEncryptionConfigKeyArn\`Required \`\`\`typescript public readonly clusterEncryptionConfigKeyArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string Amazon Resource Name (ARN) or alias of the customer master key (CMK). --- -##### \`clusterEndpoint\`Required +##### \`clusterEndpoint\`Required \`\`\`typescript public readonly clusterEndpoint: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The API Server endpoint URL. --- -##### \`clusterName\`Required +##### \`clusterName\`Required \`\`\`typescript public readonly clusterName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The physical name of the Cluster. --- -##### \`clusterSecurityGroup\`Required +##### \`clusterSecurityGroup\`Required \`\`\`typescript public readonly clusterSecurityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup The cluster security group that was created by Amazon EKS for the cluster. --- -##### \`clusterSecurityGroupId\`Required +##### \`clusterSecurityGroupId\`Required \`\`\`typescript public readonly clusterSecurityGroupId: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The id of the cluster security group that was created by Amazon EKS for the cluster. --- -##### \`openIdConnectProvider\`Required +##### \`openIdConnectProvider\`Required \`\`\`typescript public readonly openIdConnectProvider: IOpenIdConnectProvider; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IOpenIdConnectProvider\`](#aws-cdk-lib.aws_iam.IOpenIdConnectProvider) +- *Type:* aws-cdk-lib.aws_iam.IOpenIdConnectProvider The Open ID Connect Provider of the cluster used to configure Service Accounts. --- -##### \`prune\`Required +##### \`prune\`Required \`\`\`typescript public readonly prune: boolean; \`\`\` -- *Type:* \`boolean\` +- *Type:* boolean Indicates whether Kubernetes resources can be automatically pruned. @@ -90693,37 +92913,37 @@ When this is enabled (default), prune labels will be allocated and injected to e --- -##### \`vpc\`Required +##### \`vpc\`Required \`\`\`typescript public readonly vpc: IVpc; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.IVpc\`](#aws-cdk-lib.aws_ec2.IVpc) +- *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC in which this Cluster was created. --- -##### \`kubectlEnvironment\`Optional +##### \`kubectlEnvironment\`Optional \`\`\`typescript public readonly kubectlEnvironment: {[ key: string ]: string}; \`\`\` -- *Type:* {[ key: string ]: \`string\`} +- *Type:* {[ key: string ]: string} Custom environment variables when running \`kubectl\` against this cluster. --- -##### \`kubectlLayer\`Optional +##### \`kubectlLayer\`Optional \`\`\`typescript public readonly kubectlLayer: ILayerVersion; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_lambda.ILayerVersion\`](#aws-cdk-lib.aws_lambda.ILayerVersion) +- *Type:* aws-cdk-lib.aws_lambda.ILayerVersion An AWS Lambda layer that includes \`kubectl\`, \`helm\` and the \`aws\` CLI. @@ -90731,25 +92951,25 @@ If not defined, a default layer will be used. --- -##### \`kubectlMemory\`Optional +##### \`kubectlMemory\`Optional \`\`\`typescript public readonly kubectlMemory: Size; \`\`\` -- *Type:* [\`aws-cdk-lib.Size\`](#aws-cdk-lib.Size) +- *Type:* aws-cdk-lib.Size Amount of memory to allocate to the provider's lambda function. --- -##### \`kubectlPrivateSubnets\`Optional +##### \`kubectlPrivateSubnets\`Optional \`\`\`typescript public readonly kubectlPrivateSubnets: ISubnet[]; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISubnet\`](#aws-cdk-lib.aws_ec2.ISubnet)[] +- *Type:* aws-cdk-lib.aws_ec2.ISubnet[] Subnets to host the \`kubectl\` compute resources. @@ -90757,13 +92977,13 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -##### \`kubectlRole\`Optional +##### \`kubectlRole\`Optional \`\`\`typescript public readonly kubectlRole: IRole; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_iam.IRole\`](#aws-cdk-lib.aws_iam.IRole) +- *Type:* aws-cdk-lib.aws_iam.IRole An IAM role that can perform kubectl operations against this cluster. @@ -90771,13 +92991,13 @@ The role should be mapped to the \`system:masters\` Kubernetes RBAC role. --- -##### \`kubectlSecurityGroup\`Optional +##### \`kubectlSecurityGroup\`Optional \`\`\`typescript public readonly kubectlSecurityGroup: ISecurityGroup; \`\`\` -- *Type:* [\`aws-cdk-lib.aws_ec2.ISecurityGroup\`](#aws-cdk-lib.aws_ec2.ISecurityGroup) +- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup A security group to use for \`kubectl\` execution. @@ -90785,45 +93005,45 @@ If this is undefined, the k8s endpoint is expected to be accessible publicly. --- -### INodegroup +### INodegroup -- *Extends:* [\`aws-cdk-lib.IResource\`](#aws-cdk-lib.IResource) +- *Extends:* aws-cdk-lib.IResource -- *Implemented By:* [\`aws-cdk-lib.aws_eks.Nodegroup\`](#aws-cdk-lib.aws_eks.Nodegroup), [\`aws-cdk-lib.aws_eks.INodegroup\`](#aws-cdk-lib.aws_eks.INodegroup) +- *Implemented By:* Nodegroup, INodegroup NodeGroup interface. -#### Properties +#### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdklibawseksinodegrouppropertynode)* | [\`constructs.Node\`](#constructs.Node) | The tree node. | -| [\`env\`](#awscdklibawseksinodegrouppropertyenv)* | [\`aws-cdk-lib.ResourceEnvironment\`](#aws-cdk-lib.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdklibawseksinodegrouppropertystack)* | [\`aws-cdk-lib.Stack\`](#aws-cdk-lib.Stack) | The stack in which this resource is defined. | -| [\`nodegroupName\`](#awscdklibawseksinodegrouppropertynodegroupname)* | \`string\` | Name of the nodegroup. | +| node | constructs.Node | The tree node. | +| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | +| nodegroupName | string | Name of the nodegroup. | --- -##### \`node\`Required +##### \`node\`Required \`\`\`typescript public readonly node: Node; \`\`\` -- *Type:* [\`constructs.Node\`](#constructs.Node) +- *Type:* constructs.Node The tree node. --- -##### \`env\`Required +##### \`env\`Required \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` -- *Type:* [\`aws-cdk-lib.ResourceEnvironment\`](#aws-cdk-lib.ResourceEnvironment) +- *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. @@ -90831,164 +93051,164 @@ For resources that are created and managed by the CDK (generally, those created --- -##### \`stack\`Required +##### \`stack\`Required \`\`\`typescript public readonly stack: Stack; \`\`\` -- *Type:* [\`aws-cdk-lib.Stack\`](#aws-cdk-lib.Stack) +- *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- -##### \`nodegroupName\`Required +##### \`nodegroupName\`Required \`\`\`typescript public readonly nodegroupName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string Name of the nodegroup. --- -## Enums +## Enums -### CapacityType +### CapacityType | **Name** | **Description** | | --- | --- | -| [\`SPOT\`](#awscdklibawsekscapacitytypespot) | spot instances. | -| [\`ON_DEMAND\`](#awscdklibawsekscapacitytypeondemand) | on-demand instances. | +| SPOT | spot instances. | +| ON_DEMAND | on-demand instances. | --- Capacity type of the managed node group. -#### \`SPOT\` +#### \`SPOT\` spot instances. --- -#### \`ON_DEMAND\` +#### \`ON_DEMAND\` on-demand instances. --- -### CoreDnsComputeType +### CoreDnsComputeType | **Name** | **Description** | | --- | --- | -| [\`EC2\`](#awscdklibawsekscorednscomputetypeec2) | Deploy CoreDNS on EC2 instances. | -| [\`FARGATE\`](#awscdklibawsekscorednscomputetypefargate) | Deploy CoreDNS on Fargate-managed instances. | +| EC2 | Deploy CoreDNS on EC2 instances. | +| FARGATE | Deploy CoreDNS on Fargate-managed instances. | --- The type of compute resources to use for CoreDNS. -#### \`EC2\` +#### \`EC2\` Deploy CoreDNS on EC2 instances. --- -#### \`FARGATE\` +#### \`FARGATE\` Deploy CoreDNS on Fargate-managed instances. --- -### CpuArch +### CpuArch | **Name** | **Description** | | --- | --- | -| [\`ARM_64\`](#awscdklibawsekscpuarcharm64) | arm64 CPU type. | -| [\`X86_64\`](#awscdklibawsekscpuarchx8664) | x86_64 CPU type. | +| ARM_64 | arm64 CPU type. | +| X86_64 | x86_64 CPU type. | --- CPU architecture. -#### \`ARM_64\` +#### \`ARM_64\` arm64 CPU type. --- -#### \`X86_64\` +#### \`X86_64\` x86_64 CPU type. --- -### DefaultCapacityType +### DefaultCapacityType | **Name** | **Description** | | --- | --- | -| [\`NODEGROUP\`](#awscdklibawseksdefaultcapacitytypenodegroup) | managed node group. | -| [\`EC2\`](#awscdklibawseksdefaultcapacitytypeec2) | EC2 autoscaling group. | +| NODEGROUP | managed node group. | +| EC2 | EC2 autoscaling group. | --- The default capacity type for the cluster. -#### \`NODEGROUP\` +#### \`NODEGROUP\` managed node group. --- -#### \`EC2\` +#### \`EC2\` EC2 autoscaling group. --- -### MachineImageType +### MachineImageType | **Name** | **Description** | | --- | --- | -| [\`AMAZON_LINUX_2\`](#awscdklibawseksmachineimagetypeamazonlinux2) | Amazon EKS-optimized Linux AMI. | -| [\`BOTTLEROCKET\`](#awscdklibawseksmachineimagetypebottlerocket) | Bottlerocket AMI. | +| AMAZON_LINUX_2 | Amazon EKS-optimized Linux AMI. | +| BOTTLEROCKET | Bottlerocket AMI. | --- The machine image type. -#### \`AMAZON_LINUX_2\` +#### \`AMAZON_LINUX_2\` Amazon EKS-optimized Linux AMI. --- -#### \`BOTTLEROCKET\` +#### \`BOTTLEROCKET\` Bottlerocket AMI. --- -### NodegroupAmiType +### NodegroupAmiType | **Name** | **Description** | | --- | --- | -| [\`AL2_X86_64\`](#awscdklibawseksnodegroupamitypeal2x8664) | Amazon Linux 2 (x86-64). | -| [\`AL2_X86_64_GPU\`](#awscdklibawseksnodegroupamitypeal2x8664gpu) | Amazon Linux 2 with GPU support. | -| [\`AL2_ARM_64\`](#awscdklibawseksnodegroupamitypeal2arm64) | Amazon Linux 2 (ARM-64). | +| AL2_X86_64 | Amazon Linux 2 (x86-64). | +| AL2_X86_64_GPU | Amazon Linux 2 with GPU support. | +| AL2_ARM_64 | Amazon Linux 2 (ARM-64). | --- @@ -90996,87 +93216,87 @@ The AMI type for your node group. GPU instance types should use the \`AL2_x86_64_GPU\` AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the \`AL2_x86_64\` AMI type, which uses the Amazon EKS-optimized Linux AMI. -#### \`AL2_X86_64\` +#### \`AL2_X86_64\` Amazon Linux 2 (x86-64). --- -#### \`AL2_X86_64_GPU\` +#### \`AL2_X86_64_GPU\` Amazon Linux 2 with GPU support. --- -#### \`AL2_ARM_64\` +#### \`AL2_ARM_64\` Amazon Linux 2 (ARM-64). --- -### NodeType +### NodeType | **Name** | **Description** | | --- | --- | -| [\`STANDARD\`](#awscdklibawseksnodetypestandard) | Standard instances. | -| [\`GPU\`](#awscdklibawseksnodetypegpu) | GPU instances. | -| [\`INFERENTIA\`](#awscdklibawseksnodetypeinferentia) | Inferentia instances. | +| STANDARD | Standard instances. | +| GPU | GPU instances. | +| INFERENTIA | Inferentia instances. | --- Whether the worker nodes should support GPU or just standard instances. -#### \`STANDARD\` +#### \`STANDARD\` Standard instances. --- -#### \`GPU\` +#### \`GPU\` GPU instances. --- -#### \`INFERENTIA\` +#### \`INFERENTIA\` Inferentia instances. --- -### PatchType +### PatchType | **Name** | **Description** | | --- | --- | -| [\`JSON\`](#awscdklibawsekspatchtypejson) | JSON Patch, RFC 6902. | -| [\`MERGE\`](#awscdklibawsekspatchtypemerge) | JSON Merge patch. | -| [\`STRATEGIC\`](#awscdklibawsekspatchtypestrategic) | Strategic merge patch. | +| JSON | JSON Patch, RFC 6902. | +| MERGE | JSON Merge patch. | +| STRATEGIC | Strategic merge patch. | --- Values for \`kubectl patch\` --type argument. -#### \`JSON\` +#### \`JSON\` JSON Patch, RFC 6902. --- -#### \`MERGE\` +#### \`MERGE\` JSON Merge patch. --- -#### \`STRATEGIC\` +#### \`STRATEGIC\` Strategic merge patch. diff --git a/test/docgen/view/__snapshots__/enum.test.ts.snap b/test/docgen/view/__snapshots__/enum.test.ts.snap index 8e3f3d89..d3480934 100644 --- a/test/docgen/view/__snapshots__/enum.test.ts.snap +++ b/test/docgen/view/__snapshots__/enum.test.ts.snap @@ -1,25 +1,54 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" TagMutability +Object { + "displayName": "TagMutability", + "docs": Object { + "summary": "The tag mutability setting for your repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "members": Array [ + Object { + "displayName": "MUTABLE", + "docs": Object { + "summary": "allow image tags to be overwritten.", + }, + "fqn": "Amazon.CDK.AWS.ECR.TagMutability.MUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + }, + Object { + "displayName": "IMMUTABLE", + "docs": Object { + "summary": "all image tags within the repository will be immutable which will prevent them from being overwritten.", + }, + "fqn": "Amazon.CDK.AWS.ECR.TagMutability.IMMUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + }, + ], +} +`; + +exports[`csharp snapshot 2`] = ` +" TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#amazoncdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#amazoncdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -# \`MUTABLE\` +# \`MUTABLE\` allow image tags to be overwritten. --- -# \`IMMUTABLE\` +# \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. @@ -29,25 +58,54 @@ all image tags within the repository will be immutable which will prevent them f `; exports[`java snapshot 1`] = ` -" TagMutability +Object { + "displayName": "TagMutability", + "docs": Object { + "summary": "The tag mutability setting for your repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "members": Array [ + Object { + "displayName": "MUTABLE", + "docs": Object { + "summary": "allow image tags to be overwritten.", + }, + "fqn": "software.amazon.awscdk.services.ecr.TagMutability.MUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + }, + Object { + "displayName": "IMMUTABLE", + "docs": Object { + "summary": "all image tags within the repository will be immutable which will prevent them from being overwritten.", + }, + "fqn": "software.amazon.awscdk.services.ecr.TagMutability.IMMUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + }, + ], +} +`; + +exports[`java snapshot 2`] = ` +" TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#softwareamazonawscdkservicesecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -# \`MUTABLE\` +# \`MUTABLE\` allow image tags to be overwritten. --- -# \`IMMUTABLE\` +# \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. @@ -57,25 +115,54 @@ all image tags within the repository will be immutable which will prevent them f `; exports[`python snapshot 1`] = ` -" TagMutability +Object { + "displayName": "TagMutability", + "docs": Object { + "summary": "The tag mutability setting for your repository.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "members": Array [ + Object { + "displayName": "MUTABLE", + "docs": Object { + "summary": "allow image tags to be overwritten.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability.MUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + }, + Object { + "displayName": "IMMUTABLE", + "docs": Object { + "summary": "all image tags within the repository will be immutable which will prevent them from being overwritten.", + }, + "fqn": "aws_cdk.aws_ecr.TagMutability.IMMUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + }, + ], +} +`; + +exports[`python snapshot 2`] = ` +" TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -# \`MUTABLE\` +# \`MUTABLE\` allow image tags to be overwritten. --- -# \`IMMUTABLE\` +# \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. @@ -85,25 +172,54 @@ all image tags within the repository will be immutable which will prevent them f `; exports[`typescript snapshot 1`] = ` -" TagMutability +Object { + "displayName": "TagMutability", + "docs": Object { + "summary": "The tag mutability setting for your repository.", + }, + "fqn": "@aws-cdk/aws-ecr.TagMutability", + "id": "@aws-cdk/aws-ecr.TagMutability", + "members": Array [ + Object { + "displayName": "MUTABLE", + "docs": Object { + "summary": "allow image tags to be overwritten.", + }, + "fqn": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE", + }, + Object { + "displayName": "IMMUTABLE", + "docs": Object { + "summary": "all image tags within the repository will be immutable which will prevent them from being overwritten.", + }, + "fqn": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + "id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE", + }, + ], +} +`; + +exports[`typescript snapshot 2`] = ` +" TagMutability | **Name** | **Description** | | --- | --- | -| [\`MUTABLE\`](#awscdkawsecrtagmutabilitymutable) | allow image tags to be overwritten. | -| [\`IMMUTABLE\`](#awscdkawsecrtagmutabilityimmutable) | all image tags within the repository will be immutable which will prevent them from being overwritten. | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | --- The tag mutability setting for your repository. -# \`MUTABLE\` +# \`MUTABLE\` allow image tags to be overwritten. --- -# \`IMMUTABLE\` +# \`IMMUTABLE\` all image tags within the repository will be immutable which will prevent them from being overwritten. diff --git a/test/docgen/view/__snapshots__/initializer.test.ts.snap b/test/docgen/view/__snapshots__/initializer.test.ts.snap index 220dd958..46a8870e 100644 --- a/test/docgen/view/__snapshots__/initializer.test.ts.snap +++ b/test/docgen/view/__snapshots__/initializer.test.ts.snap @@ -1,7 +1,79 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" Initializers +Object { + "displayName": "Initializer", + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Initializer.parameter.Scope", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "Amazon.CDK.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "Id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Initializer.parameter.Id", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "Props", + "docs": Object { + "summary": "- resource properties.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Initializer.parameter.Props", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.props", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnPublicRepositoryProps", + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "using Amazon.CDK.AWS.ECR; + +new CfnPublicRepository(Construct Scope, string Id, CfnPublicRepositoryProps Props = null);", +} +`; + +exports[`csharp snapshot 2`] = ` +" Initializers \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -11,31 +83,31 @@ new CfnPublicRepository(Construct Scope, string Id, CfnPublicRepositoryProps Pro | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Scope\`](#amazoncdkawsecrcfnpublicrepositoryparameterscope)* | [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) | scope in which this resource is defined. | -| [\`Id\`](#amazoncdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`Props\`](#amazoncdkawsecrcfnpublicrepositoryparameterprops) | [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) | resource properties. | +| Scope | Amazon.CDK.Construct | - scope in which this resource is defined. | +| Id | string | - scoped id of the resource. | +| Props | CfnPublicRepositoryProps | - resource properties. | --- -# \`Scope\`Required +# \`Scope\`Required -- *Type:* [\`Amazon.CDK.Construct\`](#Amazon.CDK.Construct) +- *Type:* Amazon.CDK.Construct scope in which this resource is defined. --- -# \`Id\`Required +# \`Id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -# \`Props\`Optional +# \`Props\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps\`](#Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. @@ -44,7 +116,140 @@ resource properties. `; exports[`java snapshot 1`] = ` -" Initializers +Object { + "displayName": "Initializer", + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "software.amazon.awscdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "repositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.repositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.Object", + }, + }, + Object { + "default": undefined, + "displayName": "repositoryName", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.repositoryName", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "repositoryPolicyText", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.repositoryPolicyText", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.Object", + }, + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.Initializer.parameter.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.tags", + "optional": true, + "type": Object { + "formattingPattern": "java.util.List<%>", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "software.amazon.awscdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + ], + "usage": "import software.amazon.awscdk.services.ecr.CfnPublicRepository; + +CfnPublicRepository.Builder.create(Construct scope, java.lang.String id) +// .repositoryCatalogData(java.lang.Object) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build();", +} +`; + +exports[`java snapshot 2`] = ` +" Initializers \`\`\`java import software.amazon.awscdk.services.ecr.CfnPublicRepository; @@ -59,34 +264,34 @@ CfnPublicRepository.Builder.create(Construct scope, java.lang.String id) | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterscope)* | [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#softwareamazonawscdkservicesecrcfnpublicrepositoryparameterid)* | \`java.lang.String\` | scoped id of the resource. | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropsparametertags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | software.amazon.awscdk.core.Construct | - scope in which this resource is defined. | +| id | java.lang.String | - scoped id of the resource. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -# \`scope\`Required +# \`scope\`Required -- *Type:* [\`software.amazon.awscdk.core.Construct\`](#software.amazon.awscdk.core.Construct) +- *Type:* software.amazon.awscdk.core.Construct scope in which this resource is defined. --- -# \`id\`Required +# \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String scoped id of the resource. --- -# \`repositoryCatalogData\`Optional +# \`repositoryCatalogData\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -94,9 +299,9 @@ scoped id of the resource. --- -# \`repositoryName\`Optional +# \`repositoryName\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -104,9 +309,9 @@ scoped id of the resource. --- -# \`repositoryPolicyText\`Optional +# \`repositoryPolicyText\`Optional -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -114,9 +319,9 @@ scoped id of the resource. --- -# \`tags\`Optional +# \`tags\`Optional -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -127,7 +332,142 @@ scoped id of the resource. `; exports[`python snapshot 1`] = ` -" Initializers +Object { + "displayName": "Initializer", + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "aws_cdk.core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_name", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepository( + scope: Construct, + id: str, + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", +} +`; + +exports[`python snapshot 2`] = ` +" Initializers \`\`\`python import aws_cdk.aws_ecr @@ -144,34 +484,34 @@ aws_cdk.aws_ecr.CfnPublicRepository( | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`str\` | scoped id of the resource. | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropsparameterrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropsparametertags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| scope | aws_cdk.core.Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -# \`scope\`Required +# \`scope\`Required -- *Type:* [\`aws_cdk.core.Construct\`](#aws_cdk.core.Construct) +- *Type:* aws_cdk.core.Construct scope in which this resource is defined. --- -# \`id\`Required +# \`id\`Required -- *Type:* \`str\` +- *Type:* str scoped id of the resource. --- -# \`repository_catalog_data\`Optional +# \`repository_catalog_data\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -179,9 +519,9 @@ scoped id of the resource. --- -# \`repository_name\`Optional +# \`repository_name\`Optional -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -189,9 +529,9 @@ scoped id of the resource. --- -# \`repository_policy_text\`Optional +# \`repository_policy_text\`Optional -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -199,9 +539,9 @@ scoped id of the resource. --- -# \`tags\`Optional +# \`tags\`Optional -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::PublicRepository.Tags\`. @@ -212,7 +552,79 @@ scoped id of the resource. `; exports[`typescript snapshot 1`] = ` -" Initializers +Object { + "displayName": "Initializer", + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "scope", + "docs": Object { + "summary": "- scope in which this resource is defined.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Construct", + "fqn": "@aws-cdk/core.Construct", + "id": "@aws-cdk/core.Construct", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "- scoped id of the resource.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "props", + "docs": Object { + "summary": "- resource properties.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.props", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.props", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnPublicRepositoryProps", + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import { CfnPublicRepository } from '@aws-cdk/aws-ecr' + +new CfnPublicRepository(scope: Construct, id: string, props?: CfnPublicRepositoryProps)", +} +`; + +exports[`typescript snapshot 2`] = ` +" Initializers \`\`\`typescript import { CfnPublicRepository } from '@aws-cdk/aws-ecr' @@ -222,31 +634,31 @@ new CfnPublicRepository(scope: Construct, id: string, props?: CfnPublicRepositor | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`scope\`](#awscdkawsecrcfnpublicrepositoryparameterscope)* | [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) | scope in which this resource is defined. | -| [\`id\`](#awscdkawsecrcfnpublicrepositoryparameterid)* | \`string\` | scoped id of the resource. | -| [\`props\`](#awscdkawsecrcfnpublicrepositoryparameterprops) | [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) | resource properties. | +| scope | @aws-cdk/core.Construct | - scope in which this resource is defined. | +| id | string | - scoped id of the resource. | +| props | CfnPublicRepositoryProps | - resource properties. | --- -# \`scope\`Required +# \`scope\`Required -- *Type:* [\`@aws-cdk/core.Construct\`](#@aws-cdk/core.Construct) +- *Type:* @aws-cdk/core.Construct scope in which this resource is defined. --- -# \`id\`Required +# \`id\`Required -- *Type:* \`string\` +- *Type:* string scoped id of the resource. --- -# \`props\`Optional +# \`props\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.CfnPublicRepositoryProps\`](#@aws-cdk/aws-ecr.CfnPublicRepositoryProps) +- *Type:* CfnPublicRepositoryProps resource properties. diff --git a/test/docgen/view/__snapshots__/instance-method.test.ts.snap b/test/docgen/view/__snapshots__/instance-method.test.ts.snap index 8ceb90cc..e220b937 100644 --- a/test/docgen/view/__snapshots__/instance-method.test.ts.snap +++ b/test/docgen/view/__snapshots__/instance-method.test.ts.snap @@ -1,15 +1,52 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" \`Inspect\` +Object { + "displayName": "Inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Inspect", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepository.Inspect.parameter.Inspector", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "Amazon.CDK.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private Inspect(TreeInspector Inspector)", +} +`; + +exports[`csharp snapshot 2`] = ` +" \`Inspect\` \`\`\`csharp private Inspect(TreeInspector Inspector) \`\`\` -# \`Inspector\`Required +# \`Inspector\`Required -- *Type:* [\`Amazon.CDK.TreeInspector\`](#Amazon.CDK.TreeInspector) +- *Type:* Amazon.CDK.TreeInspector tree inspector to collect and process attributes. @@ -18,15 +55,52 @@ tree inspector to collect and process attributes. `; exports[`java snapshot 1`] = ` -" \`inspect\` +Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.inspect", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepository.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "software.amazon.awscdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public inspect(TreeInspector inspector)", +} +`; + +exports[`java snapshot 2`] = ` +" \`inspect\` \`\`\`java public inspect(TreeInspector inspector) \`\`\` -# \`inspector\`Required +# \`inspector\`Required -- *Type:* [\`software.amazon.awscdk.core.TreeInspector\`](#software.amazon.awscdk.core.TreeInspector) +- *Type:* software.amazon.awscdk.core.TreeInspector tree inspector to collect and process attributes. @@ -35,7 +109,46 @@ tree inspector to collect and process attributes. `; exports[`python snapshot 1`] = ` -" \`inspect\` +Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "aws_cdk.core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def inspect( + inspector: TreeInspector +)", +} +`; + +exports[`python snapshot 2`] = ` +" \`inspect\` \`\`\`python def inspect( @@ -43,9 +156,9 @@ def inspect( ) \`\`\` -# \`inspector\`Required +# \`inspector\`Required -- *Type:* [\`aws_cdk.core.TreeInspector\`](#aws_cdk.core.TreeInspector) +- *Type:* aws_cdk.core.TreeInspector tree inspector to collect and process attributes. @@ -54,15 +167,52 @@ tree inspector to collect and process attributes. `; exports[`typescript snapshot 1`] = ` -" \`inspect\` +Object { + "displayName": "inspect", + "docs": Object { + "summary": "Examines the CloudFormation resource and discloses attributes.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "inspector", + "docs": Object { + "summary": "- tree inspector to collect and process attributes.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "TreeInspector", + "fqn": "@aws-cdk/core.TreeInspector", + "id": "@aws-cdk/core.TreeInspector", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public inspect(inspector: TreeInspector)", +} +`; + +exports[`typescript snapshot 2`] = ` +" \`inspect\` \`\`\`typescript public inspect(inspector: TreeInspector) \`\`\` -# \`inspector\`Required +# \`inspector\`Required -- *Type:* [\`@aws-cdk/core.TreeInspector\`](#@aws-cdk/core.TreeInspector) +- *Type:* @aws-cdk/core.TreeInspector tree inspector to collect and process attributes. diff --git a/test/docgen/view/__snapshots__/interface.test.ts.snap b/test/docgen/view/__snapshots__/interface.test.ts.snap index 6fe5c4a6..b21191d5 100644 --- a/test/docgen/view/__snapshots__/interface.test.ts.snap +++ b/test/docgen/view/__snapshots__/interface.test.ts.snap @@ -1,229 +1,780 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" IRepository +Object { + "displayName": "IRepository", + "docs": Object { + "summary": "Represents an ECR repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "implementations": Array [ + Object { + "displayName": "Repository", + "fqn": "Amazon.CDK.AWS.ECR.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "RepositoryBase", + "fqn": "Amazon.CDK.AWS.ECR.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "IRepository", + "fqn": "Amazon.CDK.AWS.ECR.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "instanceMethods": Array [ + Object { + "displayName": "AddToResourcePolicy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.AddToResourcePolicy", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Statement", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.AddToResourcePolicy.parameter.Statement", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "Amazon.CDK.AWS.IAM.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private AddToResourcePolicy(PolicyStatement Statement)", + }, + Object { + "displayName": "Grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant", + "id": "@aws-cdk/aws-ecr.IRepository.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "Actions", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant.parameter.Actions", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "private Grant(IGrantable Grantee, string Actions)", + }, + Object { + "displayName": "GrantPull", + "docs": Object { + "summary": "Grant the given identity permissions to pull images in this repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPull", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPull.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private GrantPull(IGrantable Grantee)", + }, + Object { + "displayName": "GrantPullPush", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPullPush", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPullPush.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private GrantPullPush(IGrantable Grantee)", + }, + Object { + "displayName": "OnCloudTrailEvent", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent.parameter.Id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "Options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent.parameter.Options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "Amazon.CDK.AWS.Events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private OnCloudTrailEvent(string Id, OnEventOptions Options = null)", + }, + Object { + "displayName": "OnCloudTrailImagePushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed.parameter.Id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "Options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed.parameter.Options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnCloudTrailImagePushedOptions", + "fqn": "Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null)", + }, + Object { + "displayName": "OnEvent", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Id", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent.parameter.Id", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "Options", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent.parameter.Options", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "Amazon.CDK.AWS.Events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private OnEvent(string Id, OnEventOptions Options = null)", + }, + Object { + "displayName": "OnImageScanCompleted", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted.parameter.Id", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "Options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted.parameter.Options", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnImageScanCompletedOptions", + "fqn": "Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null)", + }, + Object { + "displayName": "RepositoryUriForDigest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForDigest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Digest", + "docs": Object { + "summary": "Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted).", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForDigest.parameter.Digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "private RepositoryUriForDigest(string Digest = null)", + }, + Object { + "displayName": "RepositoryUriForTag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForTag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Tag", + "docs": Object { + "summary": "Image tag to use (tools usually default to \\"latest\\" if omitted).", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForTag.parameter.Tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "private RepositoryUriForTag(string Tag = null)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IResource", + "fqn": "Amazon.CDK.IResource", + "id": "@aws-cdk/core.IResource", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "Node", + "docs": Object { + "summary": "The construct tree node for this construct.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Node", + "id": "@aws-cdk/aws-ecr.IRepository.property.node", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ConstructNode", + "fqn": "Amazon.CDK.ConstructNode", + "id": "@aws-cdk/core.ConstructNode", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public ConstructNode Node { get; }", + }, + Object { + "default": undefined, + "displayName": "Env", + "docs": Object { + "remarks": "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.", + "summary": "The environment this resource belongs to.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Env", + "id": "@aws-cdk/aws-ecr.IRepository.property.env", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ResourceEnvironment", + "fqn": "Amazon.CDK.ResourceEnvironment", + "id": "@aws-cdk/core.ResourceEnvironment", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public ResourceEnvironment Env { get; }", + }, + Object { + "default": undefined, + "displayName": "Stack", + "docs": Object { + "summary": "The stack in which this resource is defined.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Stack", + "id": "@aws-cdk/aws-ecr.IRepository.property.stack", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Stack", + "fqn": "Amazon.CDK.Stack", + "id": "@aws-cdk/core.Stack", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public Stack Stack { get; }", + }, + Object { + "default": undefined, + "displayName": "RepositoryArn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryArn", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public string RepositoryArn { get; }", + }, + Object { + "default": undefined, + "displayName": "RepositoryName", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryName", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public string RepositoryName { get; }", + }, + Object { + "default": undefined, + "displayName": "RepositoryUri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryUri", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public string RepositoryUri { get; }", + }, + ], +} +`; + +exports[`csharp snapshot 2`] = ` +" IRepository -- *Extends:* [\`Amazon.CDK.IResource\`](#Amazon.CDK.IResource) +- *Extends:* Amazon.CDK.IResource -- *Implemented By:* [\`Amazon.CDK.AWS.ECR.Repository\`](#Amazon.CDK.AWS.ECR.Repository), [\`Amazon.CDK.AWS.ECR.RepositoryBase\`](#Amazon.CDK.AWS.ECR.RepositoryBase), [\`Amazon.CDK.AWS.ECR.IRepository\`](#Amazon.CDK.AWS.ECR.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -# Methods +# Methods | **Name** | **Description** | | --- | --- | -| [\`AddToResourcePolicy\`](#amazoncdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`Grant\`](#amazoncdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`GrantPull\`](#amazoncdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`GrantPullPush\`](#amazoncdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`OnCloudTrailEvent\`](#amazoncdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`OnCloudTrailImagePushed\`](#amazoncdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`OnEvent\`](#amazoncdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`OnImageScanCompleted\`](#amazoncdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`RepositoryUriForDigest\`](#amazoncdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`RepositoryUriForTag\`](#amazoncdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| AddToResourcePolicy | Add a policy statement to the repository's resource policy. | +| Grant | Grant the given principal identity permissions to perform the actions on this repository. | +| GrantPull | Grant the given identity permissions to pull images in this repository. | +| GrantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| OnCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| OnCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| OnEvent | Defines a CloudWatch event rule which triggers for repository events. | +| OnImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| RepositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| RepositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -## \`AddToResourcePolicy\` +## \`AddToResourcePolicy\` \`\`\`csharp private AddToResourcePolicy(PolicyStatement Statement) \`\`\` -### \`Statement\`Required +### \`Statement\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.PolicyStatement\`](#Amazon.CDK.AWS.IAM.PolicyStatement) +- *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- -## \`Grant\` +## \`Grant\` \`\`\`csharp private Grant(IGrantable Grantee, string Actions) \`\`\` -### \`Grantee\`Required +### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -### \`Actions\`Required +### \`Actions\`Required -- *Type:* \`string\` +- *Type:* string --- -## \`GrantPull\` +## \`GrantPull\` \`\`\`csharp private GrantPull(IGrantable Grantee) \`\`\` -### \`Grantee\`Required +### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -## \`GrantPullPush\` +## \`GrantPullPush\` \`\`\`csharp private GrantPullPush(IGrantable Grantee) \`\`\` -### \`Grantee\`Required +### \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- -## \`OnCloudTrailEvent\` +## \`OnCloudTrailEvent\` \`\`\`csharp private OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` -### \`Id\`Required +### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`Options\`Optional +### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- -## \`OnCloudTrailImagePushed\` +## \`OnCloudTrailImagePushed\` \`\`\`csharp private OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` -### \`Id\`Required +### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`Options\`Optional +### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions\`](#Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -## \`OnEvent\` +## \`OnEvent\` \`\`\`csharp private OnEvent(string Id, OnEventOptions Options = null) \`\`\` -### \`Id\`Required +### \`Id\`Required -- *Type:* \`string\` +- *Type:* string --- -### \`Options\`Optional +### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.Events.OnEventOptions\`](#Amazon.CDK.AWS.Events.OnEventOptions) +- *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- -## \`OnImageScanCompleted\` +## \`OnImageScanCompleted\` \`\`\`csharp private OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` -### \`Id\`Required +### \`Id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`Options\`Optional +### \`Options\`Optional -- *Type:* [\`Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions\`](#Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -## \`RepositoryUriForDigest\` +## \`RepositoryUriForDigest\` \`\`\`csharp private RepositoryUriForDigest(string Digest = null) \`\`\` -### \`Digest\`Optional +### \`Digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -## \`RepositoryUriForTag\` +## \`RepositoryUriForTag\` \`\`\`csharp private RepositoryUriForTag(string Tag = null) \`\`\` -### \`Tag\`Optional +### \`Tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`Node\`](#amazoncdkawsecrirepositorypropertynode)* | [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) | The construct tree node for this construct. | -| [\`Env\`](#amazoncdkawsecrirepositorypropertyenv)* | [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) | The environment this resource belongs to. | -| [\`Stack\`](#amazoncdkawsecrirepositorypropertystack)* | [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) | The stack in which this resource is defined. | -| [\`RepositoryArn\`](#amazoncdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`RepositoryName\`](#amazoncdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`RepositoryUri\`](#amazoncdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| Node | Amazon.CDK.ConstructNode | The construct tree node for this construct. | +| Env | Amazon.CDK.ResourceEnvironment | The environment this resource belongs to. | +| Stack | Amazon.CDK.Stack | The stack in which this resource is defined. | +| RepositoryArn | string | The ARN of the repository. | +| RepositoryName | string | The name of the repository. | +| RepositoryUri | string | The URI of this repository (represents the latest image):. | --- -## \`Node\`Required +## \`Node\`Required \`\`\`csharp public ConstructNode Node { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ConstructNode\`](#Amazon.CDK.ConstructNode) +- *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- -## \`Env\`Required +## \`Env\`Required \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` -- *Type:* [\`Amazon.CDK.ResourceEnvironment\`](#Amazon.CDK.ResourceEnvironment) +- *Type:* Amazon.CDK.ResourceEnvironment The environment this resource belongs to. @@ -231,49 +782,49 @@ For resources that are created and managed by the CDK (generally, those created --- -## \`Stack\`Required +## \`Stack\`Required \`\`\`csharp public Stack Stack { get; } \`\`\` -- *Type:* [\`Amazon.CDK.Stack\`](#Amazon.CDK.Stack) +- *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- -## \`RepositoryArn\`Required +## \`RepositoryArn\`Required \`\`\`csharp public string RepositoryArn { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -## \`RepositoryName\`Required +## \`RepositoryName\`Required \`\`\`csharp public string RepositoryName { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -## \`RepositoryUri\`Required +## \`RepositoryUri\`Required \`\`\`csharp public string RepositoryUri { get; } \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. @@ -284,235 +835,792 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY `; exports[`java snapshot 1`] = ` -" IRepository +Object { + "displayName": "IRepository", + "docs": Object { + "summary": "Represents an ECR repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "implementations": Array [ + Object { + "displayName": "Repository", + "fqn": "software.amazon.awscdk.services.ecr.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "RepositoryBase", + "fqn": "software.amazon.awscdk.services.ecr.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "IRepository", + "fqn": "software.amazon.awscdk.services.ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "instanceMethods": Array [ + Object { + "displayName": "addToResourcePolicy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.addToResourcePolicy", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.addToResourcePolicy.parameter.statement", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "software.amazon.awscdk.services.iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public addToResourcePolicy(PolicyStatement statement)", + }, + Object { + "displayName": "grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant", + "id": "@aws-cdk/aws-ecr.IRepository.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "actions", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant.parameter.actions", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + ], + "usage": "public grant(IGrantable grantee, java.lang.String actions)", + }, + Object { + "displayName": "grantPull", + "docs": Object { + "summary": "Grant the given identity permissions to pull images in this repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPull", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPull.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public grantPull(IGrantable grantee)", + }, + Object { + "displayName": "grantPullPush", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPullPush", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPullPush.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public grantPullPush(IGrantable grantee)", + }, + Object { + "displayName": "onCloudTrailEvent", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "software.amazon.awscdk.services.events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onCloudTrailEvent(java.lang.String id) +public onCloudTrailEvent(java.lang.String id, OnEventOptions options)", + }, + Object { + "displayName": "onCloudTrailImagePushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnCloudTrailImagePushedOptions", + "fqn": "software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onCloudTrailImagePushed(java.lang.String id) +public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options)", + }, + Object { + "displayName": "onEvent", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "software.amazon.awscdk.services.events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onEvent(java.lang.String id) +public onEvent(java.lang.String id, OnEventOptions options)", + }, + Object { + "displayName": "onImageScanCompleted", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnImageScanCompletedOptions", + "fqn": "software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onImageScanCompleted(java.lang.String id) +public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options)", + }, + Object { + "displayName": "repositoryUriForDigest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForDigest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "digest", + "docs": Object { + "summary": "Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted).", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForDigest.parameter.digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + ], + "usage": "public repositoryUriForDigest() +public repositoryUriForDigest(java.lang.String digest)", + }, + Object { + "displayName": "repositoryUriForTag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForTag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "tag", + "docs": Object { + "summary": "Image tag to use (tools usually default to \\"latest\\" if omitted).", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForTag.parameter.tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.String", + }, + }, + ], + "usage": "public repositoryUriForTag() +public repositoryUriForTag(java.lang.String tag)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IResource", + "fqn": "software.amazon.awscdk.core.IResource", + "id": "@aws-cdk/core.IResource", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "node", + "docs": Object { + "summary": "The construct tree node for this construct.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.node", + "id": "@aws-cdk/aws-ecr.IRepository.property.node", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ConstructNode", + "fqn": "software.amazon.awscdk.core.ConstructNode", + "id": "@aws-cdk/core.ConstructNode", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public ConstructNode getNode();", + }, + Object { + "default": undefined, + "displayName": "env", + "docs": Object { + "remarks": "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.", + "summary": "The environment this resource belongs to.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.env", + "id": "@aws-cdk/aws-ecr.IRepository.property.env", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ResourceEnvironment", + "fqn": "software.amazon.awscdk.core.ResourceEnvironment", + "id": "@aws-cdk/core.ResourceEnvironment", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public ResourceEnvironment getEnv();", + }, + Object { + "default": undefined, + "displayName": "stack", + "docs": Object { + "summary": "The stack in which this resource is defined.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.stack", + "id": "@aws-cdk/aws-ecr.IRepository.property.stack", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Stack", + "fqn": "software.amazon.awscdk.core.Stack", + "id": "@aws-cdk/core.Stack", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public Stack getStack();", + }, + Object { + "default": undefined, + "displayName": "repositoryArn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryArn", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + "usage": "public java.lang.String getRepositoryArn();", + }, + Object { + "default": undefined, + "displayName": "repositoryName", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryName", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + "usage": "public java.lang.String getRepositoryName();", + }, + Object { + "default": undefined, + "displayName": "repositoryUri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryUri", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "java.lang.String", + }, + "usage": "public java.lang.String getRepositoryUri();", + }, + ], +} +`; -- *Extends:* [\`software.amazon.awscdk.core.IResource\`](#software.amazon.awscdk.core.IResource) +exports[`java snapshot 2`] = ` +" IRepository -- *Implemented By:* [\`software.amazon.awscdk.services.ecr.Repository\`](#software.amazon.awscdk.services.ecr.Repository), [\`software.amazon.awscdk.services.ecr.RepositoryBase\`](#software.amazon.awscdk.services.ecr.RepositoryBase), [\`software.amazon.awscdk.services.ecr.IRepository\`](#software.amazon.awscdk.services.ecr.IRepository) +- *Extends:* software.amazon.awscdk.core.IResource + +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -# Methods +# Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#softwareamazonawscdkservicesecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#softwareamazonawscdkservicesecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#softwareamazonawscdkservicesecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#softwareamazonawscdkservicesecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#softwareamazonawscdkservicesecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#softwareamazonawscdkservicesecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#softwareamazonawscdkservicesecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#softwareamazonawscdkservicesecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -## \`addToResourcePolicy\` +## \`addToResourcePolicy\` \`\`\`java public addToResourcePolicy(PolicyStatement statement) \`\`\` -### \`statement\`Required +### \`statement\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.PolicyStatement\`](#software.amazon.awscdk.services.iam.PolicyStatement) +- *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- -## \`grant\` +## \`grant\` \`\`\`java public grant(IGrantable grantee, java.lang.String actions) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -### \`actions\`Required +### \`actions\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -## \`grantPull\` +## \`grantPull\` \`\`\`java public grantPull(IGrantable grantee) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -## \`grantPullPush\` +## \`grantPullPush\` \`\`\`java public grantPullPush(IGrantable grantee) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- -## \`onCloudTrailEvent\` +## \`onCloudTrailEvent\` \`\`\`java public onCloudTrailEvent(java.lang.String id) public onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions Options for adding the rule. --- -## \`onCloudTrailImagePushed\` +## \`onCloudTrailImagePushed\` \`\`\`java public onCloudTrailImagePushed(java.lang.String id) public onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions\`](#software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -## \`onEvent\` +## \`onEvent\` \`\`\`java public onEvent(java.lang.String id) public onEvent(java.lang.String id, OnEventOptions options) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.events.OnEventOptions\`](#software.amazon.awscdk.services.events.OnEventOptions) +- *Type:* software.amazon.awscdk.services.events.OnEventOptions --- -## \`onImageScanCompleted\` +## \`onImageScanCompleted\` \`\`\`java public onImageScanCompleted(java.lang.String id) public onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions\`](#software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -## \`repositoryUriForDigest\` +## \`repositoryUriForDigest\` \`\`\`java public repositoryUriForDigest() public repositoryUriForDigest(java.lang.String digest) \`\`\` -### \`digest\`Optional +### \`digest\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -## \`repositoryUriForTag\` +## \`repositoryUriForTag\` \`\`\`java public repositoryUriForTag() public repositoryUriForTag(java.lang.String tag) \`\`\` -### \`tag\`Optional +### \`tag\`Optional -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String Image tag to use (tools usually default to \\"latest\\" if omitted). --- -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#softwareamazonawscdkservicesecrirepositorypropertynode)* | [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#softwareamazonawscdkservicesecrirepositorypropertyenv)* | [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#softwareamazonawscdkservicesecrirepositorypropertystack)* | [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryarn)* | \`java.lang.String\` | The ARN of the repository. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryname)* | \`java.lang.String\` | The name of the repository. | -| [\`repositoryUri\`](#softwareamazonawscdkservicesecrirepositorypropertyrepositoryuri)* | \`java.lang.String\` | The URI of this repository (represents the latest image):. | +| node | software.amazon.awscdk.core.ConstructNode | The construct tree node for this construct. | +| env | software.amazon.awscdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | software.amazon.awscdk.core.Stack | The stack in which this resource is defined. | +| repositoryArn | java.lang.String | The ARN of the repository. | +| repositoryName | java.lang.String | The name of the repository. | +| repositoryUri | java.lang.String | The URI of this repository (represents the latest image):. | --- -## \`node\`Required +## \`node\`Required \`\`\`java public ConstructNode getNode(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ConstructNode\`](#software.amazon.awscdk.core.ConstructNode) +- *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- -## \`env\`Required +## \`env\`Required \`\`\`java public ResourceEnvironment getEnv(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.ResourceEnvironment\`](#software.amazon.awscdk.core.ResourceEnvironment) +- *Type:* software.amazon.awscdk.core.ResourceEnvironment The environment this resource belongs to. @@ -520,49 +1628,49 @@ For resources that are created and managed by the CDK (generally, those created --- -## \`stack\`Required +## \`stack\`Required \`\`\`java public Stack getStack(); \`\`\` -- *Type:* [\`software.amazon.awscdk.core.Stack\`](#software.amazon.awscdk.core.Stack) +- *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- -## \`repositoryArn\`Required +## \`repositoryArn\`Required \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The ARN of the repository. --- -## \`repositoryName\`Required +## \`repositoryName\`Required \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The name of the repository. --- -## \`repositoryUri\`Required +## \`repositoryUri\`Required \`\`\`java public java.lang.String getRepositoryUri(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String The URI of this repository (represents the latest image):. @@ -573,32 +1681,876 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY `; exports[`python snapshot 1`] = ` -" IRepository +Object { + "displayName": "IRepository", + "docs": Object { + "summary": "Represents an ECR repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "implementations": Array [ + Object { + "displayName": "Repository", + "fqn": "aws_cdk.aws_ecr.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "RepositoryBase", + "fqn": "aws_cdk.aws_ecr.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "IRepository", + "fqn": "aws_cdk.aws_ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "instanceMethods": Array [ + Object { + "displayName": "add_to_resource_policy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy.parameter.statement", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "aws_cdk.aws_iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def add_to_resource_policy( + statement: PolicyStatement +)", + }, + Object { + "displayName": "grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant", + "id": "@aws-cdk/aws-ecr.IRepository.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "actions", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.actions", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def grant( + grantee: IGrantable, + actions: str +)", + }, + Object { + "displayName": "grant_pull", + "docs": Object { + "summary": "Grant the given identity permissions to pull images in this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull( + grantee: IGrantable +)", + }, + Object { + "displayName": "grant_pull_push", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def grant_pull_push( + grantee: IGrantable +)", + }, + Object { + "displayName": "on_cloud_trail_event", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_cloud_trail_image_pushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch changes to all tags", + "displayName": "image_tag", + "docs": Object { + "summary": "Only watch changes to this image tag.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.image_tag", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.imageTag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +)", + }, + Object { + "displayName": "on_event", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +)", + }, + Object { + "displayName": "on_image_scan_completed", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No description", + "displayName": "description", + "docs": Object { + "summary": "A description of the rule's purpose.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.description", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.description", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No additional filtering based on an event pattern.", + "displayName": "event_pattern", + "docs": Object { + "links": Array [ + "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", + ], + "remarks": "The method that generates the rule probably imposes some type of event +filtering. The filtering implied by what you pass here is added +on top of that filtering.", + "summary": "Additional restrictions for the event to route to the specified target.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.event_pattern", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.eventPattern", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "EventPattern", + "fqn": "aws_cdk.aws_events.EventPattern", + "id": "@aws-cdk/aws-events.EventPattern", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "AWS CloudFormation generates a unique physical ID.", + "displayName": "rule_name", + "docs": Object { + "summary": "A name for the rule.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.rule_name", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.ruleName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + Object { + "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", + "displayName": "target", + "docs": Object { + "summary": "The target to register for the event.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.target", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.target", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IRuleTarget", + "fqn": "aws_cdk.aws_events.IRuleTarget", + "id": "@aws-cdk/aws-events.IRuleTarget", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": "- Watch the changes to the repository with all image tags", + "displayName": "image_tags", + "docs": Object { + "remarks": "Leave it undefined to watch the full repository.", + "summary": "Only watch changes to the image tags spedified.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.image_tags", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.imageTags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "str", + }, + ], + }, + }, + ], + "usage": "def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +)", + }, + Object { + "displayName": "repository_uri_for_digest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "digest", + "docs": Object { + "summary": "Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted).", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest.parameter.digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_digest( + digest: str = None +)", + }, + Object { + "displayName": "repository_uri_for_tag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "tag", + "docs": Object { + "summary": "Image tag to use (tools usually default to \\"latest\\" if omitted).", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag.parameter.tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + }, + ], + "usage": "def repository_uri_for_tag( + tag: str = None +)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IResource", + "fqn": "aws_cdk.core.IResource", + "id": "@aws-cdk/core.IResource", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "node", + "docs": Object { + "summary": "The construct tree node for this construct.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.node", + "id": "@aws-cdk/aws-ecr.IRepository.property.node", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ConstructNode", + "fqn": "aws_cdk.core.ConstructNode", + "id": "@aws-cdk/core.ConstructNode", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "node: ConstructNode", + }, + Object { + "default": undefined, + "displayName": "env", + "docs": Object { + "remarks": "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.", + "summary": "The environment this resource belongs to.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.env", + "id": "@aws-cdk/aws-ecr.IRepository.property.env", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ResourceEnvironment", + "fqn": "aws_cdk.core.ResourceEnvironment", + "id": "@aws-cdk/core.ResourceEnvironment", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "env: ResourceEnvironment", + }, + Object { + "default": undefined, + "displayName": "stack", + "docs": Object { + "summary": "The stack in which this resource is defined.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.stack", + "id": "@aws-cdk/aws-ecr.IRepository.property.stack", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Stack", + "fqn": "aws_cdk.core.Stack", + "id": "@aws-cdk/core.Stack", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "stack: Stack", + }, + Object { + "default": undefined, + "displayName": "repository_arn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_arn", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_arn: str", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_name", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_uri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_uri", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_uri: str", + }, + ], +} +`; + +exports[`python snapshot 2`] = ` +" IRepository -- *Extends:* [\`aws_cdk.core.IResource\`](#aws_cdk.core.IResource) +- *Extends:* aws_cdk.core.IResource -- *Implemented By:* [\`aws_cdk.aws_ecr.Repository\`](#aws_cdk.aws_ecr.Repository), [\`aws_cdk.aws_ecr.RepositoryBase\`](#aws_cdk.aws_ecr.RepositoryBase), [\`aws_cdk.aws_ecr.IRepository\`](#aws_cdk.aws_ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -# Methods +# Methods | **Name** | **Description** | | --- | --- | -| [\`add_to_resource_policy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grant_pull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grant_pull_push\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`on_cloud_trail_event\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`on_cloud_trail_image_pushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`on_event\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`on_image_scan_completed\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repository_uri_for_digest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repository_uri_for_tag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to pull images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repository_uri_for_digest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -## \`add_to_resource_policy\` +## \`add_to_resource_policy\` \`\`\`python def add_to_resource_policy( @@ -606,13 +2558,13 @@ def add_to_resource_policy( ) \`\`\` -### \`statement\`Required +### \`statement\`Required -- *Type:* [\`aws_cdk.aws_iam.PolicyStatement\`](#aws_cdk.aws_iam.PolicyStatement) +- *Type:* aws_cdk.aws_iam.PolicyStatement --- -## \`grant\` +## \`grant\` \`\`\`python def grant( @@ -621,19 +2573,19 @@ def grant( ) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -### \`actions\`Required +### \`actions\`Required -- *Type:* \`str\` +- *Type:* str --- -## \`grant_pull\` +## \`grant_pull\` \`\`\`python def grant_pull( @@ -641,13 +2593,13 @@ def grant_pull( ) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -## \`grant_pull_push\` +## \`grant_pull_push\` \`\`\`python def grant_pull_push( @@ -655,13 +2607,13 @@ def grant_pull_push( ) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- -## \`on_cloud_trail_event\` +## \`on_cloud_trail_event\` \`\`\`python def on_cloud_trail_event( @@ -673,55 +2625,55 @@ def on_cloud_trail_event( ) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -### \`description\`Optional +### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -### \`event_pattern\`Optional +### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -### \`rule_name\`Optional +### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -### \`target\`Optional +### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -## \`on_cloud_trail_image_pushed\` +## \`on_cloud_trail_image_pushed\` \`\`\`python def on_cloud_trail_image_pushed( @@ -734,64 +2686,64 @@ def on_cloud_trail_image_pushed( ) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -### \`description\`Optional +### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -### \`event_pattern\`Optional +### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -### \`rule_name\`Optional +### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -### \`target\`Optional +### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -### \`image_tag\`Optional +### \`image_tag\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- -## \`on_event\` +## \`on_event\` \`\`\`python def on_event( @@ -803,53 +2755,53 @@ def on_event( ) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`str\` +- *Type:* str --- -### \`description\`Optional +### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -### \`event_pattern\`Optional +### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -### \`rule_name\`Optional +### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -### \`target\`Optional +### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -## \`on_image_scan_completed\` +## \`on_image_scan_completed\` \`\`\`python def on_image_scan_completed( @@ -862,57 +2814,57 @@ def on_image_scan_completed( ) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`str\` +- *Type:* str The id of the rule. --- -### \`description\`Optional +### \`description\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* No description A description of the rule's purpose. --- -### \`event_pattern\`Optional +### \`event_pattern\`Optional -- *Type:* [\`aws_cdk.aws_events.EventPattern\`](#aws_cdk.aws_events.EventPattern) +- *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. -> https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- -### \`rule_name\`Optional +### \`rule_name\`Optional -- *Type:* \`str\` +- *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- -### \`target\`Optional +### \`target\`Optional -- *Type:* [\`aws_cdk.aws_events.IRuleTarget\`](#aws_cdk.aws_events.IRuleTarget) +- *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- -### \`image_tags\`Optional +### \`image_tags\`Optional -- *Type:* typing.List[\`str\`] +- *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. @@ -921,7 +2873,7 @@ Leave it undefined to watch the full repository. --- -## \`repository_uri_for_digest\` +## \`repository_uri_for_digest\` \`\`\`python def repository_uri_for_digest( @@ -929,15 +2881,15 @@ def repository_uri_for_digest( ) \`\`\` -### \`digest\`Optional +### \`digest\`Optional -- *Type:* \`str\` +- *Type:* str Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -## \`repository_uri_for_tag\` +## \`repository_uri_for_tag\` \`\`\`python def repository_uri_for_tag( @@ -945,46 +2897,46 @@ def repository_uri_for_tag( ) \`\`\` -### \`tag\`Optional +### \`tag\`Optional -- *Type:* \`str\` +- *Type:* str Image tag to use (tools usually default to \\"latest\\" if omitted). --- -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) | The stack in which this resource is defined. | -| [\`repository_arn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`str\` | The ARN of the repository. | -| [\`repository_name\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`str\` | The name of the repository. | -| [\`repository_uri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`str\` | The URI of this repository (represents the latest image):. | +| node | aws_cdk.core.ConstructNode | The construct tree node for this construct. | +| env | aws_cdk.core.ResourceEnvironment | The environment this resource belongs to. | +| stack | aws_cdk.core.Stack | The stack in which this resource is defined. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | --- -## \`node\`Required +## \`node\`Required \`\`\`python node: ConstructNode \`\`\` -- *Type:* [\`aws_cdk.core.ConstructNode\`](#aws_cdk.core.ConstructNode) +- *Type:* aws_cdk.core.ConstructNode The construct tree node for this construct. --- -## \`env\`Required +## \`env\`Required \`\`\`python env: ResourceEnvironment \`\`\` -- *Type:* [\`aws_cdk.core.ResourceEnvironment\`](#aws_cdk.core.ResourceEnvironment) +- *Type:* aws_cdk.core.ResourceEnvironment The environment this resource belongs to. @@ -992,49 +2944,49 @@ For resources that are created and managed by the CDK (generally, those created --- -## \`stack\`Required +## \`stack\`Required \`\`\`python stack: Stack \`\`\` -- *Type:* [\`aws_cdk.core.Stack\`](#aws_cdk.core.Stack) +- *Type:* aws_cdk.core.Stack The stack in which this resource is defined. --- -## \`repository_arn\`Required +## \`repository_arn\`Required \`\`\`python repository_arn: str \`\`\` -- *Type:* \`str\` +- *Type:* str The ARN of the repository. --- -## \`repository_name\`Required +## \`repository_name\`Required \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str The name of the repository. --- -## \`repository_uri\`Required +## \`repository_uri\`Required \`\`\`python repository_uri: str \`\`\` -- *Type:* \`str\` +- *Type:* str The URI of this repository (represents the latest image):. @@ -1045,229 +2997,780 @@ ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY `; exports[`typescript snapshot 1`] = ` -" IRepository +Object { + "displayName": "IRepository", + "docs": Object { + "summary": "Represents an ECR repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "implementations": Array [ + Object { + "displayName": "Repository", + "fqn": "@aws-cdk/aws-ecr.Repository", + "id": "@aws-cdk/aws-ecr.Repository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "RepositoryBase", + "fqn": "@aws-cdk/aws-ecr.RepositoryBase", + "id": "@aws-cdk/aws-ecr.RepositoryBase", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + Object { + "displayName": "IRepository", + "fqn": "@aws-cdk/aws-ecr.IRepository", + "id": "@aws-cdk/aws-ecr.IRepository", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "instanceMethods": Array [ + Object { + "displayName": "addToResourcePolicy", + "docs": Object { + "summary": "Add a policy statement to the repository's resource policy.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "statement", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "PolicyStatement", + "fqn": "@aws-cdk/aws-iam.PolicyStatement", + "id": "@aws-cdk/aws-iam.PolicyStatement", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public addToResourcePolicy(statement: PolicyStatement)", + }, + Object { + "displayName": "grant", + "docs": Object { + "summary": "Grant the given principal identity permissions to perform the actions on this repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.grant", + "id": "@aws-cdk/aws-ecr.IRepository.grant", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + Object { + "default": undefined, + "displayName": "actions", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "public grant(grantee: IGrantable, actions: string)", + }, + Object { + "displayName": "grantPull", + "docs": Object { + "summary": "Grant the given identity permissions to pull images in this repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.grantPull", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public grantPull(grantee: IGrantable)", + }, + Object { + "displayName": "grantPullPush", + "docs": Object { + "summary": "Grant the given identity permissions to pull and push images to this repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public grantPullPush(grantee: IGrantable)", + }, + Object { + "displayName": "onCloudTrailEvent", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Define a CloudWatch event that triggers when something happens to this repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "@aws-cdk/aws-events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onCloudTrailEvent(id: string, options?: OnEventOptions)", + }, + Object { + "displayName": "onCloudTrailImagePushed", + "docs": Object { + "remarks": "Requires that there exists at least one CloudTrail Trail in your account +that captures the event. This method will not create the Trail.", + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnCloudTrailImagePushedOptions", + "fqn": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", + "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions)", + }, + Object { + "displayName": "onEvent", + "docs": Object { + "remarks": "Use +\`rule.addEventPattern(pattern)\` to specify a filter.", + "summary": "Defines a CloudWatch event rule which triggers for repository events.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnEventOptions", + "fqn": "@aws-cdk/aws-events.OnEventOptions", + "id": "@aws-cdk/aws-events.OnEventOptions", + "packageName": "@aws-cdk/aws-events", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onEvent(id: string, options?: OnEventOptions)", + }, + Object { + "displayName": "onImageScanCompleted", + "docs": Object { + "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "id", + "docs": Object { + "summary": "The id of the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + }, + Object { + "default": undefined, + "displayName": "options", + "docs": Object { + "summary": "Options for adding the rule.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", + "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", + "optional": true, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "OnImageScanCompletedOptions", + "fqn": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", + "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", + "packageName": "@aws-cdk/aws-ecr", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions)", + }, + Object { + "displayName": "repositoryUriForDigest", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "digest", + "docs": Object { + "summary": "Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted).", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "public repositoryUriForDigest(digest?: string)", + }, + Object { + "displayName": "repositoryUriForTag", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", + "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "tag", + "docs": Object { + "summary": "Image tag to use (tools usually default to \\"latest\\" if omitted).", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + }, + ], + "usage": "public repositoryUriForTag(tag?: string)", + }, + ], + "interfaces": Array [ + Object { + "displayName": "IResource", + "fqn": "@aws-cdk/core.IResource", + "id": "@aws-cdk/core.IResource", + "packageName": "@aws-cdk/core", + "packageVersion": "1.106.0", + "submodule": undefined, + }, + ], + "properties": Array [ + Object { + "default": undefined, + "displayName": "node", + "docs": Object { + "summary": "The construct tree node for this construct.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.node", + "id": "@aws-cdk/aws-ecr.IRepository.property.node", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ConstructNode", + "fqn": "@aws-cdk/core.ConstructNode", + "id": "@aws-cdk/core.ConstructNode", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public readonly node: ConstructNode;", + }, + Object { + "default": undefined, + "displayName": "env", + "docs": Object { + "remarks": "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.", + "summary": "The environment this resource belongs to.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.env", + "id": "@aws-cdk/aws-ecr.IRepository.property.env", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "ResourceEnvironment", + "fqn": "@aws-cdk/core.ResourceEnvironment", + "id": "@aws-cdk/core.ResourceEnvironment", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public readonly env: ResourceEnvironment;", + }, + Object { + "default": undefined, + "displayName": "stack", + "docs": Object { + "summary": "The stack in which this resource is defined.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.stack", + "id": "@aws-cdk/aws-ecr.IRepository.property.stack", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "Stack", + "fqn": "@aws-cdk/core.Stack", + "id": "@aws-cdk/core.Stack", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + "usage": "public readonly stack: Stack;", + }, + Object { + "default": undefined, + "displayName": "repositoryArn", + "docs": Object { + "summary": "The ARN of the repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public readonly repositoryArn: string;", + }, + Object { + "default": undefined, + "displayName": "repositoryName", + "docs": Object { + "summary": "The name of the repository.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public readonly repositoryName: string;", + }, + Object { + "default": undefined, + "displayName": "repositoryUri", + "docs": Object { + "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", + "summary": "The URI of this repository (represents the latest image):.", + }, + "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", + "optional": undefined, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public readonly repositoryUri: string;", + }, + ], +} +`; + +exports[`typescript snapshot 2`] = ` +" IRepository -- *Extends:* [\`@aws-cdk/core.IResource\`](#@aws-cdk/core.IResource) +- *Extends:* @aws-cdk/core.IResource -- *Implemented By:* [\`@aws-cdk/aws-ecr.Repository\`](#@aws-cdk/aws-ecr.Repository), [\`@aws-cdk/aws-ecr.RepositoryBase\`](#@aws-cdk/aws-ecr.RepositoryBase), [\`@aws-cdk/aws-ecr.IRepository\`](#@aws-cdk/aws-ecr.IRepository) +- *Implemented By:* Repository, RepositoryBase, IRepository Represents an ECR repository. -# Methods +# Methods | **Name** | **Description** | | --- | --- | -| [\`addToResourcePolicy\`](#awscdkawsecrirepositoryaddtoresourcepolicy) | Add a policy statement to the repository's resource policy. | -| [\`grant\`](#awscdkawsecrirepositorygrant) | Grant the given principal identity permissions to perform the actions on this repository. | -| [\`grantPull\`](#awscdkawsecrirepositorygrantpull) | Grant the given identity permissions to pull images in this repository. | -| [\`grantPullPush\`](#awscdkawsecrirepositorygrantpullpush) | Grant the given identity permissions to pull and push images to this repository. | -| [\`onCloudTrailEvent\`](#awscdkawsecrirepositoryoncloudtrailevent) | Define a CloudWatch event that triggers when something happens to this repository. | -| [\`onCloudTrailImagePushed\`](#awscdkawsecrirepositoryoncloudtrailimagepushed) | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | -| [\`onEvent\`](#awscdkawsecrirepositoryonevent) | Defines a CloudWatch event rule which triggers for repository events. | -| [\`onImageScanCompleted\`](#awscdkawsecrirepositoryonimagescancompleted) | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | -| [\`repositoryUriForDigest\`](#awscdkawsecrirepositoryrepositoryurifordigest) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | -| [\`repositoryUriForTag\`](#awscdkawsecrirepositoryrepositoryurifortag) | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| addToResourcePolicy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grantPull | Grant the given identity permissions to pull images in this repository. | +| grantPullPush | Grant the given identity permissions to pull and push images to this repository. | +| onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | +| onCloudTrailImagePushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| onEvent | Defines a CloudWatch event rule which triggers for repository events. | +| onImageScanCompleted | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repositoryUriForDigest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repositoryUriForTag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- -## \`addToResourcePolicy\` +## \`addToResourcePolicy\` \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement) \`\`\` -### \`statement\`Required +### \`statement\`Required -- *Type:* [\`@aws-cdk/aws-iam.PolicyStatement\`](#@aws-cdk/aws-iam.PolicyStatement) +- *Type:* @aws-cdk/aws-iam.PolicyStatement --- -## \`grant\` +## \`grant\` \`\`\`typescript public grant(grantee: IGrantable, actions: string) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -### \`actions\`Required +### \`actions\`Required -- *Type:* \`string\` +- *Type:* string --- -## \`grantPull\` +## \`grantPull\` \`\`\`typescript public grantPull(grantee: IGrantable) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -## \`grantPullPush\` +## \`grantPullPush\` \`\`\`typescript public grantPullPush(grantee: IGrantable) \`\`\` -### \`grantee\`Required +### \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- -## \`onCloudTrailEvent\` +## \`onCloudTrailEvent\` \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- -## \`onCloudTrailImagePushed\` +## \`onCloudTrailImagePushed\` \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions\`](#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions) +- *Type:* OnCloudTrailImagePushedOptions Options for adding the rule. --- -## \`onEvent\` +## \`onEvent\` \`\`\`typescript public onEvent(id: string, options?: OnEventOptions) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`string\` +- *Type:* string --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-events.OnEventOptions\`](#@aws-cdk/aws-events.OnEventOptions) +- *Type:* @aws-cdk/aws-events.OnEventOptions --- -## \`onImageScanCompleted\` +## \`onImageScanCompleted\` \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions) \`\`\` -### \`id\`Required +### \`id\`Required -- *Type:* \`string\` +- *Type:* string The id of the rule. --- -### \`options\`Optional +### \`options\`Optional -- *Type:* [\`@aws-cdk/aws-ecr.OnImageScanCompletedOptions\`](#@aws-cdk/aws-ecr.OnImageScanCompletedOptions) +- *Type:* OnImageScanCompletedOptions Options for adding the rule. --- -## \`repositoryUriForDigest\` +## \`repositoryUriForDigest\` \`\`\`typescript public repositoryUriForDigest(digest?: string) \`\`\` -### \`digest\`Optional +### \`digest\`Optional -- *Type:* \`string\` +- *Type:* string Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). --- -## \`repositoryUriForTag\` +## \`repositoryUriForTag\` \`\`\`typescript public repositoryUriForTag(tag?: string) \`\`\` -### \`tag\`Optional +### \`tag\`Optional -- *Type:* \`string\` +- *Type:* string Image tag to use (tools usually default to \\"latest\\" if omitted). --- -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`node\`](#awscdkawsecrirepositorypropertynode)* | [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) | The construct tree node for this construct. | -| [\`env\`](#awscdkawsecrirepositorypropertyenv)* | [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) | The environment this resource belongs to. | -| [\`stack\`](#awscdkawsecrirepositorypropertystack)* | [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) | The stack in which this resource is defined. | -| [\`repositoryArn\`](#awscdkawsecrirepositorypropertyrepositoryarn)* | \`string\` | The ARN of the repository. | -| [\`repositoryName\`](#awscdkawsecrirepositorypropertyrepositoryname)* | \`string\` | The name of the repository. | -| [\`repositoryUri\`](#awscdkawsecrirepositorypropertyrepositoryuri)* | \`string\` | The URI of this repository (represents the latest image):. | +| node | @aws-cdk/core.ConstructNode | The construct tree node for this construct. | +| env | @aws-cdk/core.ResourceEnvironment | The environment this resource belongs to. | +| stack | @aws-cdk/core.Stack | The stack in which this resource is defined. | +| repositoryArn | string | The ARN of the repository. | +| repositoryName | string | The name of the repository. | +| repositoryUri | string | The URI of this repository (represents the latest image):. | --- -## \`node\`Required +## \`node\`Required \`\`\`typescript public readonly node: ConstructNode; \`\`\` -- *Type:* [\`@aws-cdk/core.ConstructNode\`](#@aws-cdk/core.ConstructNode) +- *Type:* @aws-cdk/core.ConstructNode The construct tree node for this construct. --- -## \`env\`Required +## \`env\`Required \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` -- *Type:* [\`@aws-cdk/core.ResourceEnvironment\`](#@aws-cdk/core.ResourceEnvironment) +- *Type:* @aws-cdk/core.ResourceEnvironment The environment this resource belongs to. @@ -1275,49 +3778,49 @@ For resources that are created and managed by the CDK (generally, those created --- -## \`stack\`Required +## \`stack\`Required \`\`\`typescript public readonly stack: Stack; \`\`\` -- *Type:* [\`@aws-cdk/core.Stack\`](#@aws-cdk/core.Stack) +- *Type:* @aws-cdk/core.Stack The stack in which this resource is defined. --- -## \`repositoryArn\`Required +## \`repositoryArn\`Required \`\`\`typescript public readonly repositoryArn: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The ARN of the repository. --- -## \`repositoryName\`Required +## \`repositoryName\`Required \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The name of the repository. --- -## \`repositoryUri\`Required +## \`repositoryUri\`Required \`\`\`typescript public readonly repositoryUri: string; \`\`\` -- *Type:* \`string\` +- *Type:* string The URI of this repository (represents the latest image):. diff --git a/test/docgen/view/__snapshots__/markdown.test.ts.snap b/test/docgen/view/__snapshots__/markdown.test.ts.snap new file mode 100644 index 00000000..0fd0904b --- /dev/null +++ b/test/docgen/view/__snapshots__/markdown.test.ts.snap @@ -0,0 +1,6631 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`custom anchor formatter 1`] = ` +"# Amazon ECR Construct Library + +--- + + +![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) + +![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge) + +--- + + +This package contains constructs for working with Amazon Elastic Container Registry. + +## Repositories + +Define a repository by creating a new instance of \`Repository\`. A repository +holds multiple verions of a single container image. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(self, \\"Repository\\") +\`\`\` + +## Image scanning + +Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable \`imageScanOnPush\` in the properties + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(stack, \\"Repo\\", + image_scan_on_push=True +) +\`\`\` + +To create an \`onImageScanCompleted\` event rule and trigger the event target + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.on_image_scan_completed(\\"ImageScanComplete\\").add_target(...) +\`\`\` + +### Authorization Token + +Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull +images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and +additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests. +More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth). + +A Docker authorization token can be obtained using the \`GetAuthorizationToken\` ECR API. The following code snippets +grants an IAM user access to call this API. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr + +user = iam.User(self, \\"User\\", ...) +ecr.AuthorizationToken.grant_read(user) +\`\`\` + +If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from +higher rate and bandwidth limits. + +> See \`Pricing\` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html). + +The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr + +user = iam.User(self, \\"User\\", ...) +ecr.PublicGalleryAuthorizationToken.grant_read(user) +\`\`\` + +This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth). + +### Image tag immutability + +You can set tag immutability on images in our repository using the \`imageTagMutability\` construct prop. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +ecr.Repository(stack, \\"Repo\\", image_tag_mutability=ecr.TagMutability.IMMUTABLE) +\`\`\` + +## Automatically clean up repositories + +You can set life cycle rules to automatically clean up old images from your +repository. The first life cycle rule that matches an image will be applied +against that image. For example, the following deletes images older than +30 days, while keeping all images tagged with prod (note that the order +is important here): + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.add_lifecycle_rule(tag_prefix_list=[\\"prod\\"], max_image_count=9999) +repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) +\`\`\` +# API Reference + +## Constructs + +### CfnPublicRepository + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::PublicRepository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepository( + scope: Construct, + id: str, + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`repository_catalog_data\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_name\`Optional + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| tags | TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` + +- *Type:* TagManager + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +##### \`repository_catalog_data\`Required + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRegistryPolicy + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicy( + scope: Construct, + id: str, + policy_text: typing.Any +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`policy_text\`Required + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_registry_id | str | *No description.* | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`attr_registry_id\`Required + +\`\`\`python +attr_registry_id: str +\`\`\` + +- *Type:* str + +--- + +##### \`policy_text\`Required + +\`\`\`python +policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnReplicationConfiguration + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration( + scope: Construct, + id: str, + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`replication_configuration\`Required + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_registry_id | str | *No description.* | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`attr_registry_id\`Required + +\`\`\`python +attr_registry_id: str +\`\`\` + +- *Type:* str + +--- + +##### \`replication_configuration\`Required + +\`\`\`python +replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRepository + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::Repository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepository( + scope: Construct, + id: str, + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::Repository.Tags\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`encryption_configuration\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`image_tag_mutability\`Optional + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| attr_repository_uri | str | *No description.* | +| tags | TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`attr_repository_uri\`Required + +\`\`\`python +attr_repository_uri: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` + +- *Type:* TagManager + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +##### \`encryption_configuration\`Required + +\`\`\`python +encryption_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Required + +\`\`\`python +image_scanning_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +\`\`\`python +lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### Repository + +Define an ECR repository. + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository( + scope: Construct, + id: str, + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | *No description.* | +| id | str | *No description.* | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +--- + +##### \`id\`Required + +- *Type:* str + +--- + +##### \`image_scan_on_push\`Optional + +- *Type:* bool +- *Default:* false + +Enable the scan on push when creating the repository. + +--- + +##### \`image_tag_mutability\`Optional + +- *Type:* TagMutability +- *Default:* TagMutability.MUTABLE + +The tag mutability setting for the repository. + +If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. + +--- + +##### \`lifecycle_registry_id\`Optional + +- *Type:* str +- *Default:* The default registry is assumed. + +The AWS account ID associated with the registry that contains the repository. + +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) + +--- + +##### \`lifecycle_rules\`Optional + +- *Type:* typing.List[LifecycleRule] +- *Default:* No life cycle rules + +Life cycle rules to apply to this registry. + +--- + +##### \`removal_policy\`Optional + +- *Type:* RemovalPolicy +- *Default:* RemovalPolicy.Retain + +Determine what happens to the repository when the resource/stack is deleted. + +--- + +##### \`repository_name\`Optional + +- *Type:* str +- *Default:* Automatically generated name. + +Name for this repository. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_lifecycle_rule | Add a life cycle rule to the repository. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | + +--- + +##### \`add_lifecycle_rule\` + +\`\`\`python +def add_lifecycle_rule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +) +\`\`\` + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +Describes the purpose of the rule. + +--- + +###### \`max_image_age\`Optional + +- *Type:* Duration + +The maximum age of images to retain. The value must represent a number of days. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +###### \`max_image_count\`Optional + +- *Type:* typing.Union[int, float] + +The maximum number of images to retain. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +###### \`rule_priority\`Optional + +- *Type:* typing.Union[int, float] +- *Default:* Automatically assigned + +Controls the order in which rules are evaluated (low to high). + +All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. + +--- + +###### \`tag_prefix_list\`Optional + +- *Type:* typing.List[str] + +Select images that have ALL the given prefixes in their tag. + +Only if tagStatus == TagStatus.Tagged + +--- + +###### \`tag_status\`Optional + +- *Type:* TagStatus +- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise + +Select images based on tags. + +Only one rule is allowed to select untagged images, and it must have the highest rulePriority. + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| arn_for_local_repository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| from_repository_arn | *No description.* | +| from_repository_attributes | Import a repository. | +| from_repository_name | *No description.* | + +--- + +##### \`arn_for_local_repository\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.arn_for_local_repository( + repository_name: str, + scope: IConstruct, + account: str = None +) +\`\`\` + +###### \`repository_name\`Required + +- *Type:* str + +--- + +###### \`scope\`Required + +- *Type:* IConstruct + +--- + +###### \`account\`Optional + +- *Type:* str + +--- + +##### \`from_repository_arn\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_arn( + scope: Construct, + id: str, + repository_arn: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_arn\`Required + +- *Type:* str + +--- + +##### \`from_repository_attributes\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_attributes( + scope: Construct, + id: str, + repository_arn: str, + repository_name: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_arn\`Required + +- *Type:* str + +--- + +###### \`repository_name\`Required + +- *Type:* str + +--- + +##### \`from_repository_name\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_name( + scope: Construct, + id: str, + repository_name: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_name\`Required + +- *Type:* str + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + + +### RepositoryBase + +- *Implements:* IRepository + +Base class for ECR repository. + +Reused between imported repositories and owned repositories. + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryBase( + scope: Construct, + id: str, + account: str = None, + environment_from_arn: str = None, + physical_name: str = None, + region: str = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | *No description.* | +| id | str | *No description.* | +| account | str | The AWS account ID this resource belongs to. | +| environment_from_arn | str | ARN to deduce region and account from. | +| physical_name | str | The value passed in by users to the physical name prop of the resource. | +| region | str | The AWS region this resource belongs to. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +--- + +##### \`id\`Required + +- *Type:* str + +--- + +##### \`account\`Optional + +- *Type:* str +- *Default:* the resource is in the same account as the stack it belongs to + +The AWS account ID this resource belongs to. + +--- + +##### \`environment_from_arn\`Optional + +- *Type:* str +- *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. + +ARN to deduce region and account from. + +The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either \`account\` or \`region\`. + +--- + +##### \`physical_name\`Optional + +- *Type:* str +- *Default:* The physical name will be allocated by CloudFormation at deployment time + +The value passed in by users to the physical name prop of the resource. + +\`undefined\` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - \`PhysicalName.GENERATE_IF_NEEDED\` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. + +--- + +##### \`region\`Optional + +- *Type:* str +- *Default:* the resource is in the same region as the stack it belongs to + +The AWS region this resource belongs to. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to use the images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repository_uri_for_digest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +##### \`grant\` + +\`\`\`python +def grant( + grantee: IGrantable, + actions: str +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +###### \`actions\`Required + +- *Type:* str + +--- + +##### \`grant_pull\` + +\`\`\`python +def grant_pull( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`grant_pull_push\` + +\`\`\`python +def grant_pull_push( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`on_cloud_trail_event\` + +\`\`\`python +def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_cloud_trail_image_pushed\` + +\`\`\`python +def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tag\`Optional + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +##### \`on_event\` + +\`\`\`python +def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_image_scan_completed\` + +\`\`\`python +def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tags\`Optional + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +##### \`repository_uri_for_digest\` + +\`\`\`python +def repository_uri_for_digest( + digest: str = None +) +\`\`\` + +###### \`digest\`Optional + +- *Type:* str + +Optional image digest. + +--- + +##### \`repository_uri_for_tag\` + +\`\`\`python +def repository_uri_for_tag( + tag: str = None +) +\`\`\` + +###### \`tag\`Optional + +- *Type:* str + +Optional image tag. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + +##### \`repository_uri\`Required + +\`\`\`python +repository_uri: str +\`\`\` + +- *Type:* str + +The URI of this repository (represents the latest image):. + +ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY + +--- + + +## Structs + +### CfnPublicRepositoryProps + +Properties for defining a \`AWS::ECR::PublicRepository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepositoryProps( + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | + +--- + +##### \`repository_catalog_data\`Optional + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +\`\`\`python +tags: typing.List[CfnTag] +\`\`\` + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +### CfnRegistryPolicyProps + +Properties for defining a \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicyProps( + policy_text: typing.Any +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`policy_text\`Required + +\`\`\`python +policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +### CfnReplicationConfigurationProps + +Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfigurationProps( + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`replication_configuration\`Required + +\`\`\`python +replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +### CfnRepositoryProps + +Properties for defining a \`AWS::ECR::Repository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepositoryProps( + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::Repository.Tags\`. | + +--- + +##### \`encryption_configuration\`Optional + +\`\`\`python +encryption_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Optional + +\`\`\`python +image_scanning_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +\`\`\`python +lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +\`\`\`python +tags: typing.List[CfnTag] +\`\`\` + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +### LifecyclePolicyProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( + lifecycle_policy_text: str = None, + registry_id: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| lifecycle_policy_text | str | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registry_id | str | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | + +--- + +##### \`lifecycle_policy_text\`Optional + +\`\`\`python +lifecycle_policy_text: str +\`\`\` + +- *Type:* str + +\`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext) + +--- + +##### \`registry_id\`Optional + +\`\`\`python +registry_id: str +\`\`\` + +- *Type:* str + +\`CfnRepository.LifecyclePolicyProperty.RegistryId\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid) + +--- + +### LifecycleRule + +An ECR life cycle rule. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.LifecycleRule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | Describes the purpose of the rule. | +| max_image_age | Duration | The maximum age of images to retain. The value must represent a number of days. | +| max_image_count | typing.Union[int, float] | The maximum number of images to retain. | +| rule_priority | typing.Union[int, float] | Controls the order in which rules are evaluated (low to high). | +| tag_prefix_list | typing.List[str] | Select images that have ALL the given prefixes in their tag. | +| tag_status | TagStatus | Select images based on tags. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +Describes the purpose of the rule. + +--- + +##### \`max_image_age\`Optional + +\`\`\`python +max_image_age: Duration +\`\`\` + +- *Type:* Duration + +The maximum age of images to retain. The value must represent a number of days. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +##### \`max_image_count\`Optional + +\`\`\`python +max_image_count: typing.Union[int, float] +\`\`\` + +- *Type:* typing.Union[int, float] + +The maximum number of images to retain. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +##### \`rule_priority\`Optional + +\`\`\`python +rule_priority: typing.Union[int, float] +\`\`\` + +- *Type:* typing.Union[int, float] +- *Default:* Automatically assigned + +Controls the order in which rules are evaluated (low to high). + +All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. + +--- + +##### \`tag_prefix_list\`Optional + +\`\`\`python +tag_prefix_list: typing.List[str] +\`\`\` + +- *Type:* typing.List[str] + +Select images that have ALL the given prefixes in their tag. + +Only if tagStatus == TagStatus.Tagged + +--- + +##### \`tag_status\`Optional + +\`\`\`python +tag_status: TagStatus +\`\`\` + +- *Type:* TagStatus +- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise + +Select images based on tags. + +Only one rule is allowed to select untagged images, and it must have the highest rulePriority. + +--- + +### OnCloudTrailImagePushedOptions + +Options for the onCloudTrailImagePushed method. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | A description of the rule's purpose. | +| event_pattern | EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | IRuleTarget | The target to register for the event. | +| image_tag | str | Only watch changes to this image tag. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +##### \`event_pattern\`Optional + +\`\`\`python +event_pattern: EventPattern +\`\`\` + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +##### \`rule_name\`Optional + +\`\`\`python +rule_name: str +\`\`\` + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +##### \`target\`Optional + +\`\`\`python +target: IRuleTarget +\`\`\` + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`image_tag\`Optional + +\`\`\`python +image_tag: str +\`\`\` + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +### OnImageScanCompletedOptions + +Options for the OnImageScanCompleted method. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.OnImageScanCompletedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | A description of the rule's purpose. | +| event_pattern | EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | IRuleTarget | The target to register for the event. | +| image_tags | typing.List[str] | Only watch changes to the image tags spedified. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +##### \`event_pattern\`Optional + +\`\`\`python +event_pattern: EventPattern +\`\`\` + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +##### \`rule_name\`Optional + +\`\`\`python +rule_name: str +\`\`\` + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +##### \`target\`Optional + +\`\`\`python +target: IRuleTarget +\`\`\` + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`image_tags\`Optional + +\`\`\`python +image_tags: typing.List[str] +\`\`\` + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +### ReplicationConfigurationProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( + rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rules | typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | + +--- + +##### \`rules\`Required + +\`\`\`python +rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +\`\`\` + +- *Type:* typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] + +\`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules) + +--- + +### ReplicationDestinationProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( + region: str, + registry_id: str +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| region | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registry_id | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | + +--- + +##### \`region\`Required + +\`\`\`python +region: str +\`\`\` + +- *Type:* str + +\`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region) + +--- + +##### \`registry_id\`Required + +\`\`\`python +registry_id: str +\`\`\` + +- *Type:* str + +\`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid) + +--- + +### ReplicationRuleProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( + destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| destinations | typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | + +--- + +##### \`destinations\`Required + +\`\`\`python +destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +\`\`\` + +- *Type:* typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] + +\`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations) + +--- + +### RepositoryAttributes + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryAttributes( + repository_arn: str, + repository_name: str +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | *No description.* | +| repository_name | str | *No description.* | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +--- + +### RepositoryProps + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryProps( + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | + +--- + +##### \`image_scan_on_push\`Optional + +\`\`\`python +image_scan_on_push: bool +\`\`\` + +- *Type:* bool +- *Default:* false + +Enable the scan on push when creating the repository. + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: TagMutability +\`\`\` + +- *Type:* TagMutability +- *Default:* TagMutability.MUTABLE + +The tag mutability setting for the repository. + +If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. + +--- + +##### \`lifecycle_registry_id\`Optional + +\`\`\`python +lifecycle_registry_id: str +\`\`\` + +- *Type:* str +- *Default:* The default registry is assumed. + +The AWS account ID associated with the registry that contains the repository. + +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) + +--- + +##### \`lifecycle_rules\`Optional + +\`\`\`python +lifecycle_rules: typing.List[LifecycleRule] +\`\`\` + +- *Type:* typing.List[LifecycleRule] +- *Default:* No life cycle rules + +Life cycle rules to apply to this registry. + +--- + +##### \`removal_policy\`Optional + +\`\`\`python +removal_policy: RemovalPolicy +\`\`\` + +- *Type:* RemovalPolicy +- *Default:* RemovalPolicy.Retain + +Determine what happens to the repository when the resource/stack is deleted. + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str +- *Default:* Automatically generated name. + +Name for this repository. + +--- + +## Classes + +### AuthorizationToken + +Authorization token to access private ECR repositories in the current environment via Docker CLI. + +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| grant_read | Grant access to retrieve an authorization token. | + +--- + +##### \`grant_read\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.AuthorizationToken.grant_read( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + + + +### PublicGalleryAuthorizationToken + +Authorization token to access the global public ECR Gallery via Docker CLI. + +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| grant_read | Grant access to retrieve an authorization token. | + +--- + +##### \`grant_read\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + + + +## Protocols + +### IRepository + +- *Extends:* IResource + +- *Implemented By:* Repository, RepositoryBase, IRepository + +Represents an ECR repository. + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to pull images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repository_uri_for_digest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +##### \`grant\` + +\`\`\`python +def grant( + grantee: IGrantable, + actions: str +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +###### \`actions\`Required + +- *Type:* str + +--- + +##### \`grant_pull\` + +\`\`\`python +def grant_pull( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`grant_pull_push\` + +\`\`\`python +def grant_pull_push( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`on_cloud_trail_event\` + +\`\`\`python +def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_cloud_trail_image_pushed\` + +\`\`\`python +def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tag\`Optional + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +##### \`on_event\` + +\`\`\`python +def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_image_scan_completed\` + +\`\`\`python +def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tags\`Optional + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +##### \`repository_uri_for_digest\` + +\`\`\`python +def repository_uri_for_digest( + digest: str = None +) +\`\`\` + +###### \`digest\`Optional + +- *Type:* str + +Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). + +--- + +##### \`repository_uri_for_tag\` + +\`\`\`python +def repository_uri_for_tag( + tag: str = None +) +\`\`\` + +###### \`tag\`Optional + +- *Type:* str + +Image tag to use (tools usually default to \\"latest\\" if omitted). + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | ConstructNode | The construct tree node for this construct. | +| env | ResourceEnvironment | The environment this resource belongs to. | +| stack | Stack | The stack in which this resource is defined. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | + +--- + +##### \`node\`Required + +\`\`\`python +node: ConstructNode +\`\`\` + +- *Type:* ConstructNode + +The construct tree node for this construct. + +--- + +##### \`env\`Required + +\`\`\`python +env: ResourceEnvironment +\`\`\` + +- *Type:* ResourceEnvironment + +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. + +--- + +##### \`stack\`Required + +\`\`\`python +stack: Stack +\`\`\` + +- *Type:* Stack + +The stack in which this resource is defined. + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + +##### \`repository_uri\`Required + +\`\`\`python +repository_uri: str +\`\`\` + +- *Type:* str + +The URI of this repository (represents the latest image):. + +ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY + +--- + +## Enums + +### TagMutability + +| **Name** | **Description** | +| --- | --- | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | + +--- + +The tag mutability setting for your repository. + +#### \`MUTABLE\` + +allow image tags to be overwritten. + +--- + + +#### \`IMMUTABLE\` + +all image tags within the repository will be immutable which will prevent them from being overwritten. + +--- + + +### TagStatus + +| **Name** | **Description** | +| --- | --- | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | + +--- + +Select images based on tags. + +#### \`ANY\` + +Rule applies to all images. + +--- + + +#### \`TAGGED\` + +Rule applies to tagged images. + +--- + + +#### \`UNTAGGED\` + +Rule applies to untagged images. + +--- + +" +`; + +exports[`custom link formatter 1`] = ` +"# Amazon ECR Construct Library + +--- + + +![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge) + +![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge) + +--- + + +This package contains constructs for working with Amazon Elastic Container Registry. + +## Repositories + +Define a repository by creating a new instance of \`Repository\`. A repository +holds multiple verions of a single container image. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(self, \\"Repository\\") +\`\`\` + +## Image scanning + +Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable \`imageScanOnPush\` in the properties + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository = ecr.Repository(stack, \\"Repo\\", + image_scan_on_push=True +) +\`\`\` + +To create an \`onImageScanCompleted\` event rule and trigger the event target + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.on_image_scan_completed(\\"ImageScanComplete\\").add_target(...) +\`\`\` + +### Authorization Token + +Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull +images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and +additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests. +More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth). + +A Docker authorization token can be obtained using the \`GetAuthorizationToken\` ECR API. The following code snippets +grants an IAM user access to call this API. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr + +user = iam.User(self, \\"User\\", ...) +ecr.AuthorizationToken.grant_read(user) +\`\`\` + +If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from +higher rate and bandwidth limits. + +> See \`Pricing\` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html). + +The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +import aws_cdk.aws_iam as iam +import aws_cdk.aws_ecr as ecr + +user = iam.User(self, \\"User\\", ...) +ecr.PublicGalleryAuthorizationToken.grant_read(user) +\`\`\` + +This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth). + +### Image tag immutability + +You can set tag immutability on images in our repository using the \`imageTagMutability\` construct prop. + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +ecr.Repository(stack, \\"Repo\\", image_tag_mutability=ecr.TagMutability.IMMUTABLE) +\`\`\` + +## Automatically clean up repositories + +You can set life cycle rules to automatically clean up old images from your +repository. The first life cycle rule that matches an image will be applied +against that image. For example, the following deletes images older than +30 days, while keeping all images tagged with prod (note that the order +is important here): + +\`\`\`python +# Example automatically generated from non-compiling source. May contain errors. +repository.add_lifecycle_rule(tag_prefix_list=[\\"prod\\"], max_image_count=9999) +repository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30)) +\`\`\` +# API Reference + +## Constructs + +### CfnPublicRepository + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::PublicRepository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepository( + scope: Construct, + id: str, + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`repository_catalog_data\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_name\`Optional + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| tags | TagManager | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` + +- *Type:* TagManager + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +##### \`repository_catalog_data\`Required + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRegistryPolicy + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicy( + scope: Construct, + id: str, + policy_text: typing.Any +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`policy_text\`Required + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_registry_id | str | *No description.* | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`attr_registry_id\`Required + +\`\`\`python +attr_registry_id: str +\`\`\` + +- *Type:* str + +--- + +##### \`policy_text\`Required + +\`\`\`python +policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnReplicationConfiguration + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration( + scope: Construct, + id: str, + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`replication_configuration\`Required + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_registry_id | str | *No description.* | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`attr_registry_id\`Required + +\`\`\`python +attr_registry_id: str +\`\`\` + +- *Type:* str + +--- + +##### \`replication_configuration\`Required + +\`\`\`python +replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### CfnRepository + +- *Implements:* IInspectable + +A CloudFormation \`AWS::ECR::Repository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepository( + scope: Construct, + id: str, + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | - scope in which this resource is defined. | +| id | str | - scoped id of the resource. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::Repository.Tags\`. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +scope in which this resource is defined. + +--- + +##### \`id\`Required + +- *Type:* str + +scoped id of the resource. + +--- + +##### \`encryption_configuration\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`image_tag_mutability\`Optional + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| inspect | Examines the CloudFormation resource and discloses attributes. | + +--- + +##### \`inspect\` + +\`\`\`python +def inspect( + inspector: TreeInspector +) +\`\`\` + +###### \`inspector\`Required + +- *Type:* TreeInspector + +tree inspector to collect and process attributes. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attr_arn | str | *No description.* | +| attr_repository_uri | str | *No description.* | +| tags | TagManager | \`AWS::ECR::Repository.Tags\`. | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | + +--- + +##### \`attr_arn\`Required + +\`\`\`python +attr_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`attr_repository_uri\`Required + +\`\`\`python +attr_repository_uri: str +\`\`\` + +- *Type:* str + +--- + +##### \`tags\`Required + +\`\`\`python +tags: TagManager +\`\`\` + +- *Type:* TagManager + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +##### \`encryption_configuration\`Required + +\`\`\`python +encryption_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Required + +\`\`\`python +image_scanning_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`repository_policy_text\`Required + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +\`\`\`python +lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| CFN_RESOURCE_TYPE_NAME | str | The CloudFormation resource type name for this resource class. | + +--- + +##### \`CFN_RESOURCE_TYPE_NAME\`Required + +\`\`\`python +CFN_RESOURCE_TYPE_NAME: str +\`\`\` + +- *Type:* str + +The CloudFormation resource type name for this resource class. + +--- + +### Repository + +Define an ECR repository. + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository( + scope: Construct, + id: str, + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | *No description.* | +| id | str | *No description.* | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +--- + +##### \`id\`Required + +- *Type:* str + +--- + +##### \`image_scan_on_push\`Optional + +- *Type:* bool +- *Default:* false + +Enable the scan on push when creating the repository. + +--- + +##### \`image_tag_mutability\`Optional + +- *Type:* TagMutability +- *Default:* TagMutability.MUTABLE + +The tag mutability setting for the repository. + +If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. + +--- + +##### \`lifecycle_registry_id\`Optional + +- *Type:* str +- *Default:* The default registry is assumed. + +The AWS account ID associated with the registry that contains the repository. + +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) + +--- + +##### \`lifecycle_rules\`Optional + +- *Type:* typing.List[LifecycleRule] +- *Default:* No life cycle rules + +Life cycle rules to apply to this registry. + +--- + +##### \`removal_policy\`Optional + +- *Type:* RemovalPolicy +- *Default:* RemovalPolicy.Retain + +Determine what happens to the repository when the resource/stack is deleted. + +--- + +##### \`repository_name\`Optional + +- *Type:* str +- *Default:* Automatically generated name. + +Name for this repository. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_lifecycle_rule | Add a life cycle rule to the repository. | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | + +--- + +##### \`add_lifecycle_rule\` + +\`\`\`python +def add_lifecycle_rule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +) +\`\`\` + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +Describes the purpose of the rule. + +--- + +###### \`max_image_age\`Optional + +- *Type:* Duration + +The maximum age of images to retain. The value must represent a number of days. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +###### \`max_image_count\`Optional + +- *Type:* typing.Union[int, float] + +The maximum number of images to retain. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +###### \`rule_priority\`Optional + +- *Type:* typing.Union[int, float] +- *Default:* Automatically assigned + +Controls the order in which rules are evaluated (low to high). + +All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. + +--- + +###### \`tag_prefix_list\`Optional + +- *Type:* typing.List[str] + +Select images that have ALL the given prefixes in their tag. + +Only if tagStatus == TagStatus.Tagged + +--- + +###### \`tag_status\`Optional + +- *Type:* TagStatus +- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise + +Select images based on tags. + +Only one rule is allowed to select untagged images, and it must have the highest rulePriority. + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| arn_for_local_repository | Returns an ECR ARN for a repository that resides in the same account/region as the current stack. | +| from_repository_arn | *No description.* | +| from_repository_attributes | Import a repository. | +| from_repository_name | *No description.* | + +--- + +##### \`arn_for_local_repository\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.arn_for_local_repository( + repository_name: str, + scope: IConstruct, + account: str = None +) +\`\`\` + +###### \`repository_name\`Required + +- *Type:* str + +--- + +###### \`scope\`Required + +- *Type:* IConstruct + +--- + +###### \`account\`Optional + +- *Type:* str + +--- + +##### \`from_repository_arn\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_arn( + scope: Construct, + id: str, + repository_arn: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_arn\`Required + +- *Type:* str + +--- + +##### \`from_repository_attributes\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_attributes( + scope: Construct, + id: str, + repository_arn: str, + repository_name: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_arn\`Required + +- *Type:* str + +--- + +###### \`repository_name\`Required + +- *Type:* str + +--- + +##### \`from_repository_name\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.Repository.from_repository_name( + scope: Construct, + id: str, + repository_name: str +) +\`\`\` + +###### \`scope\`Required + +- *Type:* Construct + +--- + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`repository_name\`Required + +- *Type:* str + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + + +### RepositoryBase + +- *Implements:* IRepository + +Base class for ECR repository. + +Reused between imported repositories and owned repositories. + +#### Initializers + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryBase( + scope: Construct, + id: str, + account: str = None, + environment_from_arn: str = None, + physical_name: str = None, + region: str = None +) +\`\`\` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | Construct | *No description.* | +| id | str | *No description.* | +| account | str | The AWS account ID this resource belongs to. | +| environment_from_arn | str | ARN to deduce region and account from. | +| physical_name | str | The value passed in by users to the physical name prop of the resource. | +| region | str | The AWS region this resource belongs to. | + +--- + +##### \`scope\`Required + +- *Type:* Construct + +--- + +##### \`id\`Required + +- *Type:* str + +--- + +##### \`account\`Optional + +- *Type:* str +- *Default:* the resource is in the same account as the stack it belongs to + +The AWS account ID this resource belongs to. + +--- + +##### \`environment_from_arn\`Optional + +- *Type:* str +- *Default:* take environment from \`account\`, \`region\` parameters, or use Stack environment. + +ARN to deduce region and account from. + +The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either \`account\` or \`region\`. + +--- + +##### \`physical_name\`Optional + +- *Type:* str +- *Default:* The physical name will be allocated by CloudFormation at deployment time + +The value passed in by users to the physical name prop of the resource. + +\`undefined\` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - \`PhysicalName.GENERATE_IF_NEEDED\` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. + +--- + +##### \`region\`Optional + +- *Type:* str +- *Default:* the resource is in the same region as the stack it belongs to + +The AWS region this resource belongs to. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to use the images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. | +| repository_uri_for_digest | Returns the URL of the repository. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URL of the repository. Can be used in \`docker push/pull\`. | + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +##### \`grant\` + +\`\`\`python +def grant( + grantee: IGrantable, + actions: str +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +###### \`actions\`Required + +- *Type:* str + +--- + +##### \`grant_pull\` + +\`\`\`python +def grant_pull( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`grant_pull_push\` + +\`\`\`python +def grant_pull_push( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`on_cloud_trail_event\` + +\`\`\`python +def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_cloud_trail_image_pushed\` + +\`\`\`python +def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tag\`Optional + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +##### \`on_event\` + +\`\`\`python +def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_image_scan_completed\` + +\`\`\`python +def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tags\`Optional + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +##### \`repository_uri_for_digest\` + +\`\`\`python +def repository_uri_for_digest( + digest: str = None +) +\`\`\` + +###### \`digest\`Optional + +- *Type:* str + +Optional image digest. + +--- + +##### \`repository_uri_for_tag\` + +\`\`\`python +def repository_uri_for_tag( + tag: str = None +) +\`\`\` + +###### \`tag\`Optional + +- *Type:* str + +Optional image tag. + +--- + + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + +##### \`repository_uri\`Required + +\`\`\`python +repository_uri: str +\`\`\` + +- *Type:* str + +The URI of this repository (represents the latest image):. + +ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY + +--- + + +## Structs + +### CfnPublicRepositoryProps + +Properties for defining a \`AWS::ECR::PublicRepository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepositoryProps( + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | + +--- + +##### \`repository_catalog_data\`Optional + +\`\`\`python +repository_catalog_data: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryCatalogData\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::PublicRepository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::PublicRepository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +\`\`\`python +tags: typing.List[CfnTag] +\`\`\` + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::PublicRepository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags) + +--- + +### CfnRegistryPolicyProps + +Properties for defining a \`AWS::ECR::RegistryPolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRegistryPolicyProps( + policy_text: typing.Any +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| policy_text | typing.Any | \`AWS::ECR::RegistryPolicy.PolicyText\`. | + +--- + +##### \`policy_text\`Required + +\`\`\`python +policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::RegistryPolicy.PolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext) + +--- + +### CfnReplicationConfigurationProps + +Properties for defining a \`AWS::ECR::ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfigurationProps( + replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| replication_configuration | typing.Union[IResolvable, ReplicationConfigurationProperty] | \`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. | + +--- + +##### \`replication_configuration\`Required + +\`\`\`python +replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, ReplicationConfigurationProperty] + +\`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration) + +--- + +### CfnRepositoryProps + +Properties for defining a \`AWS::ECR::Repository\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepositoryProps( + encryption_configuration: typing.Any = None, + image_scanning_configuration: typing.Any = None, + image_tag_mutability: str = None, + lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| encryption_configuration | typing.Any | \`AWS::ECR::Repository.EncryptionConfiguration\`. | +| image_scanning_configuration | typing.Any | \`AWS::ECR::Repository.ImageScanningConfiguration\`. | +| image_tag_mutability | str | \`AWS::ECR::Repository.ImageTagMutability\`. | +| lifecycle_policy | typing.Union[IResolvable, LifecyclePolicyProperty] | \`AWS::ECR::Repository.LifecyclePolicy\`. | +| repository_name | str | \`AWS::ECR::Repository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::Repository.RepositoryPolicyText\`. | +| tags | typing.List[CfnTag] | \`AWS::ECR::Repository.Tags\`. | + +--- + +##### \`encryption_configuration\`Optional + +\`\`\`python +encryption_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.EncryptionConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration) + +--- + +##### \`image_scanning_configuration\`Optional + +\`\`\`python +image_scanning_configuration: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.ImageScanningConfiguration\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration) + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.ImageTagMutability\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability) + +--- + +##### \`lifecycle_policy\`Optional + +\`\`\`python +lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] +\`\`\` + +- *Type:* typing.Union[IResolvable, LifecyclePolicyProperty] + +\`AWS::ECR::Repository.LifecyclePolicy\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy) + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +\`AWS::ECR::Repository.RepositoryName\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname) + +--- + +##### \`repository_policy_text\`Optional + +\`\`\`python +repository_policy_text: typing.Any +\`\`\` + +- *Type:* typing.Any + +\`AWS::ECR::Repository.RepositoryPolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext) + +--- + +##### \`tags\`Optional + +\`\`\`python +tags: typing.List[CfnTag] +\`\`\` + +- *Type:* typing.List[CfnTag] + +\`AWS::ECR::Repository.Tags\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags) + +--- + +### LifecyclePolicyProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty( + lifecycle_policy_text: str = None, + registry_id: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| lifecycle_policy_text | str | \`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. | +| registry_id | str | \`CfnRepository.LifecyclePolicyProperty.RegistryId\`. | + +--- + +##### \`lifecycle_policy_text\`Optional + +\`\`\`python +lifecycle_policy_text: str +\`\`\` + +- *Type:* str + +\`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext) + +--- + +##### \`registry_id\`Optional + +\`\`\`python +registry_id: str +\`\`\` + +- *Type:* str + +\`CfnRepository.LifecyclePolicyProperty.RegistryId\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid) + +--- + +### LifecycleRule + +An ECR life cycle rule. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.LifecycleRule( + description: str = None, + max_image_age: Duration = None, + max_image_count: typing.Union[int, float] = None, + rule_priority: typing.Union[int, float] = None, + tag_prefix_list: typing.List[str] = None, + tag_status: TagStatus = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | Describes the purpose of the rule. | +| max_image_age | Duration | The maximum age of images to retain. The value must represent a number of days. | +| max_image_count | typing.Union[int, float] | The maximum number of images to retain. | +| rule_priority | typing.Union[int, float] | Controls the order in which rules are evaluated (low to high). | +| tag_prefix_list | typing.List[str] | Select images that have ALL the given prefixes in their tag. | +| tag_status | TagStatus | Select images based on tags. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +Describes the purpose of the rule. + +--- + +##### \`max_image_age\`Optional + +\`\`\`python +max_image_age: Duration +\`\`\` + +- *Type:* Duration + +The maximum age of images to retain. The value must represent a number of days. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +##### \`max_image_count\`Optional + +\`\`\`python +max_image_count: typing.Union[int, float] +\`\`\` + +- *Type:* typing.Union[int, float] + +The maximum number of images to retain. + +Specify exactly one of maxImageCount and maxImageAge. + +--- + +##### \`rule_priority\`Optional + +\`\`\`python +rule_priority: typing.Union[int, float] +\`\`\` + +- *Type:* typing.Union[int, float] +- *Default:* Automatically assigned + +Controls the order in which rules are evaluated (low to high). + +All rules must have a unique priority, where lower numbers have higher precedence. The first rule that matches is applied to an image. There can only be one rule with a tagStatus of Any, and it must have the highest rulePriority. All rules without a specified priority will have incrementing priorities automatically assigned to them, higher than any rules that DO have priorities. + +--- + +##### \`tag_prefix_list\`Optional + +\`\`\`python +tag_prefix_list: typing.List[str] +\`\`\` + +- *Type:* typing.List[str] + +Select images that have ALL the given prefixes in their tag. + +Only if tagStatus == TagStatus.Tagged + +--- + +##### \`tag_status\`Optional + +\`\`\`python +tag_status: TagStatus +\`\`\` + +- *Type:* TagStatus +- *Default:* TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise + +Select images based on tags. + +Only one rule is allowed to select untagged images, and it must have the highest rulePriority. + +--- + +### OnCloudTrailImagePushedOptions + +Options for the onCloudTrailImagePushed method. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | A description of the rule's purpose. | +| event_pattern | EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | IRuleTarget | The target to register for the event. | +| image_tag | str | Only watch changes to this image tag. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +##### \`event_pattern\`Optional + +\`\`\`python +event_pattern: EventPattern +\`\`\` + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +##### \`rule_name\`Optional + +\`\`\`python +rule_name: str +\`\`\` + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +##### \`target\`Optional + +\`\`\`python +target: IRuleTarget +\`\`\` + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`image_tag\`Optional + +\`\`\`python +image_tag: str +\`\`\` + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +### OnImageScanCompletedOptions + +Options for the OnImageScanCompleted method. + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.OnImageScanCompletedOptions( + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | str | A description of the rule's purpose. | +| event_pattern | EventPattern | Additional restrictions for the event to route to the specified target. | +| rule_name | str | A name for the rule. | +| target | IRuleTarget | The target to register for the event. | +| image_tags | typing.List[str] | Only watch changes to the image tags spedified. | + +--- + +##### \`description\`Optional + +\`\`\`python +description: str +\`\`\` + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +##### \`event_pattern\`Optional + +\`\`\`python +event_pattern: EventPattern +\`\`\` + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +##### \`rule_name\`Optional + +\`\`\`python +rule_name: str +\`\`\` + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +##### \`target\`Optional + +\`\`\`python +target: IRuleTarget +\`\`\` + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`image_tags\`Optional + +\`\`\`python +image_tags: typing.List[str] +\`\`\` + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +### ReplicationConfigurationProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( + rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rules | typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] | \`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. | + +--- + +##### \`rules\`Required + +\`\`\`python +rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] +\`\`\` + +- *Type:* typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]] + +\`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules) + +--- + +### ReplicationDestinationProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( + region: str, + registry_id: str +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| region | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. | +| registry_id | str | \`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. | + +--- + +##### \`region\`Required + +\`\`\`python +region: str +\`\`\` + +- *Type:* str + +\`CfnReplicationConfiguration.ReplicationDestinationProperty.Region\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region) + +--- + +##### \`registry_id\`Required + +\`\`\`python +registry_id: str +\`\`\` + +- *Type:* str + +\`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid) + +--- + +### ReplicationRuleProperty + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html) + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty( + destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| destinations | typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] | \`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. | + +--- + +##### \`destinations\`Required + +\`\`\`python +destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] +\`\`\` + +- *Type:* typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]] + +\`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations\`. + +> [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations) + +--- + +### RepositoryAttributes + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryAttributes( + repository_arn: str, + repository_name: str +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository_arn | str | *No description.* | +| repository_name | str | *No description.* | + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +--- + +### RepositoryProps + +#### Initializer + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.RepositoryProps( + image_scan_on_push: bool = None, + image_tag_mutability: TagMutability = None, + lifecycle_registry_id: str = None, + lifecycle_rules: typing.List[LifecycleRule] = None, + removal_policy: RemovalPolicy = None, + repository_name: str = None +) +\`\`\` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| image_scan_on_push | bool | Enable the scan on push when creating the repository. | +| image_tag_mutability | TagMutability | The tag mutability setting for the repository. | +| lifecycle_registry_id | str | The AWS account ID associated with the registry that contains the repository. | +| lifecycle_rules | typing.List[LifecycleRule] | Life cycle rules to apply to this registry. | +| removal_policy | RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | +| repository_name | str | Name for this repository. | + +--- + +##### \`image_scan_on_push\`Optional + +\`\`\`python +image_scan_on_push: bool +\`\`\` + +- *Type:* bool +- *Default:* false + +Enable the scan on push when creating the repository. + +--- + +##### \`image_tag_mutability\`Optional + +\`\`\`python +image_tag_mutability: TagMutability +\`\`\` + +- *Type:* TagMutability +- *Default:* TagMutability.MUTABLE + +The tag mutability setting for the repository. + +If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. + +--- + +##### \`lifecycle_registry_id\`Optional + +\`\`\`python +lifecycle_registry_id: str +\`\`\` + +- *Type:* str +- *Default:* The default registry is assumed. + +The AWS account ID associated with the registry that contains the repository. + +> [https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html) + +--- + +##### \`lifecycle_rules\`Optional + +\`\`\`python +lifecycle_rules: typing.List[LifecycleRule] +\`\`\` + +- *Type:* typing.List[LifecycleRule] +- *Default:* No life cycle rules + +Life cycle rules to apply to this registry. + +--- + +##### \`removal_policy\`Optional + +\`\`\`python +removal_policy: RemovalPolicy +\`\`\` + +- *Type:* RemovalPolicy +- *Default:* RemovalPolicy.Retain + +Determine what happens to the repository when the resource/stack is deleted. + +--- + +##### \`repository_name\`Optional + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str +- *Default:* Automatically generated name. + +Name for this repository. + +--- + +## Classes + +### AuthorizationToken + +Authorization token to access private ECR repositories in the current environment via Docker CLI. + +> [https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html) + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| grant_read | Grant access to retrieve an authorization token. | + +--- + +##### \`grant_read\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.AuthorizationToken.grant_read( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + + + +### PublicGalleryAuthorizationToken + +Authorization token to access the global public ECR Gallery via Docker CLI. + +> [https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth) + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| grant_read | Grant access to retrieve an authorization token. | + +--- + +##### \`grant_read\` + +\`\`\`python +import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + + + +## Protocols + +### IRepository + +- *Extends:* IResource + +- *Implemented By:* Repository, RepositoryBase, IRepository + +Represents an ECR repository. + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| add_to_resource_policy | Add a policy statement to the repository's resource policy. | +| grant | Grant the given principal identity permissions to perform the actions on this repository. | +| grant_pull | Grant the given identity permissions to pull images in this repository. | +| grant_pull_push | Grant the given identity permissions to pull and push images to this repository. | +| on_cloud_trail_event | Define a CloudWatch event that triggers when something happens to this repository. | +| on_cloud_trail_image_pushed | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | +| on_event | Defines a CloudWatch event rule which triggers for repository events. | +| on_image_scan_completed | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | +| repository_uri_for_digest | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | +| repository_uri_for_tag | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | + +--- + +##### \`add_to_resource_policy\` + +\`\`\`python +def add_to_resource_policy( + statement: PolicyStatement +) +\`\`\` + +###### \`statement\`Required + +- *Type:* PolicyStatement + +--- + +##### \`grant\` + +\`\`\`python +def grant( + grantee: IGrantable, + actions: str +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +###### \`actions\`Required + +- *Type:* str + +--- + +##### \`grant_pull\` + +\`\`\`python +def grant_pull( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`grant_pull_push\` + +\`\`\`python +def grant_pull_push( + grantee: IGrantable +) +\`\`\` + +###### \`grantee\`Required + +- *Type:* IGrantable + +--- + +##### \`on_cloud_trail_event\` + +\`\`\`python +def on_cloud_trail_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_cloud_trail_image_pushed\` + +\`\`\`python +def on_cloud_trail_image_pushed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tag: str = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tag\`Optional + +- *Type:* str +- *Default:* Watch changes to all tags + +Only watch changes to this image tag. + +--- + +##### \`on_event\` + +\`\`\`python +def on_event( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +##### \`on_image_scan_completed\` + +\`\`\`python +def on_image_scan_completed( + id: str, + description: str = None, + event_pattern: EventPattern = None, + rule_name: str = None, + target: IRuleTarget = None, + image_tags: typing.List[str] = None +) +\`\`\` + +###### \`id\`Required + +- *Type:* str + +The id of the rule. + +--- + +###### \`description\`Optional + +- *Type:* str +- *Default:* No description + +A description of the rule's purpose. + +--- + +###### \`event_pattern\`Optional + +- *Type:* EventPattern +- *Default:* No additional filtering based on an event pattern. + +Additional restrictions for the event to route to the specified target. + +The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. + +> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + +--- + +###### \`rule_name\`Optional + +- *Type:* str +- *Default:* AWS CloudFormation generates a unique physical ID. + +A name for the rule. + +--- + +###### \`target\`Optional + +- *Type:* IRuleTarget +- *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. + +The target to register for the event. + +--- + +###### \`image_tags\`Optional + +- *Type:* typing.List[str] +- *Default:* Watch the changes to the repository with all image tags + +Only watch changes to the image tags spedified. + +Leave it undefined to watch the full repository. + +--- + +##### \`repository_uri_for_digest\` + +\`\`\`python +def repository_uri_for_digest( + digest: str = None +) +\`\`\` + +###### \`digest\`Optional + +- *Type:* str + +Image digest to use (tools usually default to the image with the \\"latest\\" tag if omitted). + +--- + +##### \`repository_uri_for_tag\` + +\`\`\`python +def repository_uri_for_tag( + tag: str = None +) +\`\`\` + +###### \`tag\`Optional + +- *Type:* str + +Image tag to use (tools usually default to \\"latest\\" if omitted). + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| node | ConstructNode | The construct tree node for this construct. | +| env | ResourceEnvironment | The environment this resource belongs to. | +| stack | Stack | The stack in which this resource is defined. | +| repository_arn | str | The ARN of the repository. | +| repository_name | str | The name of the repository. | +| repository_uri | str | The URI of this repository (represents the latest image):. | + +--- + +##### \`node\`Required + +\`\`\`python +node: ConstructNode +\`\`\` + +- *Type:* ConstructNode + +The construct tree node for this construct. + +--- + +##### \`env\`Required + +\`\`\`python +env: ResourceEnvironment +\`\`\` + +- *Type:* ResourceEnvironment + +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. + +--- + +##### \`stack\`Required + +\`\`\`python +stack: Stack +\`\`\` + +- *Type:* Stack + +The stack in which this resource is defined. + +--- + +##### \`repository_arn\`Required + +\`\`\`python +repository_arn: str +\`\`\` + +- *Type:* str + +The ARN of the repository. + +--- + +##### \`repository_name\`Required + +\`\`\`python +repository_name: str +\`\`\` + +- *Type:* str + +The name of the repository. + +--- + +##### \`repository_uri\`Required + +\`\`\`python +repository_uri: str +\`\`\` + +- *Type:* str + +The URI of this repository (represents the latest image):. + +ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY + +--- + +## Enums + +### TagMutability + +| **Name** | **Description** | +| --- | --- | +| MUTABLE | allow image tags to be overwritten. | +| IMMUTABLE | all image tags within the repository will be immutable which will prevent them from being overwritten. | + +--- + +The tag mutability setting for your repository. + +#### \`MUTABLE\` + +allow image tags to be overwritten. + +--- + + +#### \`IMMUTABLE\` + +all image tags within the repository will be immutable which will prevent them from being overwritten. + +--- + + +### TagStatus + +| **Name** | **Description** | +| --- | --- | +| ANY | Rule applies to all images. | +| TAGGED | Rule applies to tagged images. | +| UNTAGGED | Rule applies to untagged images. | + +--- + +Select images based on tags. + +#### \`ANY\` + +Rule applies to all images. + +--- + + +#### \`TAGGED\` + +Rule applies to tagged images. + +--- + + +#### \`UNTAGGED\` + +Rule applies to untagged images. + +--- + +" +`; diff --git a/test/docgen/view/__snapshots__/parameter.test.ts.snap b/test/docgen/view/__snapshots__/parameter.test.ts.snap index 9d7e58e7..a9be7935 100644 --- a/test/docgen/view/__snapshots__/parameter.test.ts.snap +++ b/test/docgen/view/__snapshots__/parameter.test.ts.snap @@ -1,27 +1,75 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" \`Grantee\`Required +Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken.GrantRead.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, +} +`; + +exports[`csharp snapshot 2`] = ` +" \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- " `; exports[`java snapshot 1`] = ` -" \`grantee\`Required +Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, +} +`; + +exports[`java snapshot 2`] = ` +" \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- " `; -exports[`newlines in "defaults" are removed snapshot 1`] = ` -" \`grantee\`Required +exports[`newlines in "defaults" are removed 1`] = ` +" \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable - *Default:* default option with a newline --- @@ -29,18 +77,66 @@ exports[`newlines in "defaults" are removed snapshot 1`] = ` `; exports[`python snapshot 1`] = ` -" \`grantee\`Required +Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, +} +`; + +exports[`python snapshot 2`] = ` +" \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- " `; exports[`typescript snapshot 1`] = ` -" \`grantee\`Required +Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, +} +`; + +exports[`typescript snapshot 2`] = ` +" \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- " diff --git a/test/docgen/view/__snapshots__/property.test.ts.snap b/test/docgen/view/__snapshots__/property.test.ts.snap index 457e1efa..143428e8 100644 --- a/test/docgen/view/__snapshots__/property.test.ts.snap +++ b/test/docgen/view/__snapshots__/property.test.ts.snap @@ -1,13 +1,33 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" \`RepositoryCatalogData\`Optional +Object { + "default": undefined, + "displayName": "RepositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps.property.RepositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "object", + }, + "usage": "public object RepositoryCatalogData { get; set; }", +} +`; + +exports[`csharp snapshot 2`] = ` +" \`RepositoryCatalogData\`Optional \`\`\`csharp public object RepositoryCatalogData { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -18,13 +38,33 @@ public object RepositoryCatalogData { get; set; } `; exports[`java snapshot 1`] = ` -" \`repositoryCatalogData\`Optional +Object { + "default": undefined, + "displayName": "repositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.Object", + }, + "usage": "public java.lang.Object getRepositoryCatalogData();", +} +`; + +exports[`java snapshot 2`] = ` +" \`repositoryCatalogData\`Optional \`\`\`java public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -35,13 +75,33 @@ public java.lang.Object getRepositoryCatalogData(); `; exports[`python snapshot 1`] = ` -" \`repository_catalog_data\`Optional +Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_catalog_data: typing.Any", +} +`; + +exports[`python snapshot 2`] = ` +" \`repository_catalog_data\`Optional \`\`\`python repository_catalog_data: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -52,13 +112,33 @@ repository_catalog_data: typing.Any `; exports[`typescript snapshot 1`] = ` -" \`repositoryCatalogData\`Optional +Object { + "default": undefined, + "displayName": "repositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "any", + }, + "usage": "public readonly repositoryCatalogData: any;", +} +`; + +exports[`typescript snapshot 2`] = ` +" \`repositoryCatalogData\`Optional \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. diff --git a/test/docgen/view/__snapshots__/static-function.test.ts.snap b/test/docgen/view/__snapshots__/static-function.test.ts.snap index 03e029b7..1218641e 100644 --- a/test/docgen/view/__snapshots__/static-function.test.ts.snap +++ b/test/docgen/view/__snapshots__/static-function.test.ts.snap @@ -1,7 +1,44 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" \`GrantRead\` +Object { + "displayName": "GrantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken.GrantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "Grantee", + "docs": Object {}, + "fqn": "Amazon.CDK.AWS.ECR.AuthorizationToken.GrantRead.parameter.Grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "Amazon.CDK.AWS.IAM.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "using Amazon.CDK.AWS.ECR; + +AuthorizationToken.GrantRead(IGrantable Grantee);", +} +`; + +exports[`csharp snapshot 2`] = ` +" \`GrantRead\` \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -9,16 +46,53 @@ using Amazon.CDK.AWS.ECR; AuthorizationToken.GrantRead(IGrantable Grantee); \`\`\` -# \`Grantee\`Required +# \`Grantee\`Required -- *Type:* [\`Amazon.CDK.AWS.IAM.IGrantable\`](#Amazon.CDK.AWS.IAM.IGrantable) +- *Type:* Amazon.CDK.AWS.IAM.IGrantable --- " `; exports[`java snapshot 1`] = ` -" \`grantRead\` +Object { + "displayName": "grantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken.grantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "software.amazon.awscdk.services.ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "software.amazon.awscdk.services.iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import software.amazon.awscdk.services.ecr.AuthorizationToken; + +AuthorizationToken.grantRead(IGrantable grantee)", +} +`; + +exports[`java snapshot 2`] = ` +" \`grantRead\` \`\`\`java import software.amazon.awscdk.services.ecr.AuthorizationToken; @@ -26,16 +100,55 @@ import software.amazon.awscdk.services.ecr.AuthorizationToken; AuthorizationToken.grantRead(IGrantable grantee) \`\`\` -# \`grantee\`Required +# \`grantee\`Required -- *Type:* [\`software.amazon.awscdk.services.iam.IGrantable\`](#software.amazon.awscdk.services.iam.IGrantable) +- *Type:* software.amazon.awscdk.services.iam.IGrantable --- " `; exports[`python snapshot 1`] = ` -" \`grant_read\` +Object { + "displayName": "grant_read", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "aws_cdk.aws_iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.AuthorizationToken.grant_read( + grantee: IGrantable +)", +} +`; + +exports[`python snapshot 2`] = ` +" \`grant_read\` \`\`\`python import aws_cdk.aws_ecr @@ -45,16 +158,53 @@ aws_cdk.aws_ecr.AuthorizationToken.grant_read( ) \`\`\` -# \`grantee\`Required +# \`grantee\`Required -- *Type:* [\`aws_cdk.aws_iam.IGrantable\`](#aws_cdk.aws_iam.IGrantable) +- *Type:* aws_cdk.aws_iam.IGrantable --- " `; exports[`typescript snapshot 1`] = ` -" \`grantRead\` +Object { + "displayName": "grantRead", + "docs": Object { + "summary": "Grant access to retrieve an authorization token.", + }, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead", + "parameters": Array [ + Object { + "default": undefined, + "displayName": "grantee", + "docs": Object {}, + "fqn": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee", + "optional": undefined, + "type": Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "IGrantable", + "fqn": "@aws-cdk/aws-iam.IGrantable", + "id": "@aws-cdk/aws-iam.IGrantable", + "packageName": "@aws-cdk/aws-iam", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + }, + ], + "usage": "import { AuthorizationToken } from '@aws-cdk/aws-ecr' + +AuthorizationToken.grantRead(grantee: IGrantable)", +} +`; + +exports[`typescript snapshot 2`] = ` +" \`grantRead\` \`\`\`typescript import { AuthorizationToken } from '@aws-cdk/aws-ecr' @@ -62,9 +212,9 @@ import { AuthorizationToken } from '@aws-cdk/aws-ecr' AuthorizationToken.grantRead(grantee: IGrantable) \`\`\` -# \`grantee\`Required +# \`grantee\`Required -- *Type:* [\`@aws-cdk/aws-iam.IGrantable\`](#@aws-cdk/aws-iam.IGrantable) +- *Type:* @aws-cdk/aws-iam.IGrantable --- " diff --git a/test/docgen/view/__snapshots__/struct.test.ts.snap b/test/docgen/view/__snapshots__/struct.test.ts.snap index 40f93c0e..30538ef2 100644 --- a/test/docgen/view/__snapshots__/struct.test.ts.snap +++ b/test/docgen/view/__snapshots__/struct.test.ts.snap @@ -1,13 +1,120 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` -" CfnPublicRepositoryProps +Object { + "displayName": "CfnPublicRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "RepositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps.property.RepositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "object", + }, + "usage": "public object RepositoryCatalogData { get; set; }", + }, + Object { + "default": undefined, + "displayName": "RepositoryName", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps.property.RepositoryName", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public string RepositoryName { get; set; }", + }, + Object { + "default": undefined, + "displayName": "RepositoryPolicyText", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps.property.RepositoryPolicyText", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "object", + }, + "usage": "public object RepositoryPolicyText { get; set; }", + }, + Object { + "default": undefined, + "displayName": "Tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "Amazon.CDK.AWS.ECR.CfnPublicRepositoryProps.property.Tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "%[]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "Amazon.CDK.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "public CfnTag[] Tags { get; set; }", + }, + ], + "usage": "using Amazon.CDK.AWS.ECR; + +new CfnPublicRepositoryProps { + object RepositoryCatalogData = null, + string RepositoryName = null, + object RepositoryPolicyText = null, + CfnTag[] Tags = null +};", +} +`; + +exports[`csharp snapshot 2`] = ` +" CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -# Initializer +# Initializer \`\`\`csharp using Amazon.CDK.AWS.ECR; @@ -20,24 +127,24 @@ new CfnPublicRepositoryProps { }; \`\`\` -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`RepositoryCatalogData\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`RepositoryName\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`RepositoryPolicyText\`](#amazoncdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`Tags\`](#amazoncdkawsecrcfnpublicrepositorypropspropertytags) | [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| RepositoryCatalogData | object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| RepositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| RepositoryPolicyText | object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| Tags | Amazon.CDK.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -## \`RepositoryCatalogData\`Optional +## \`RepositoryCatalogData\`Optional \`\`\`csharp public object RepositoryCatalogData { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -45,13 +152,13 @@ public object RepositoryCatalogData { get; set; } --- -## \`RepositoryName\`Optional +## \`RepositoryName\`Optional \`\`\`csharp public string RepositoryName { get; set; } \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -59,13 +166,13 @@ public string RepositoryName { get; set; } --- -## \`RepositoryPolicyText\`Optional +## \`RepositoryPolicyText\`Optional \`\`\`csharp public object RepositoryPolicyText { get; set; } \`\`\` -- *Type:* \`object\` +- *Type:* object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -73,13 +180,13 @@ public object RepositoryPolicyText { get; set; } --- -## \`Tags\`Optional +## \`Tags\`Optional \`\`\`csharp public CfnTag[] Tags { get; set; } \`\`\` -- *Type:* [\`Amazon.CDK.CfnTag\`](#Amazon.CDK.CfnTag)[] +- *Type:* Amazon.CDK.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. @@ -90,13 +197,120 @@ public CfnTag[] Tags { get; set; } `; exports[`java snapshot 1`] = ` -" CfnPublicRepositoryProps +Object { + "displayName": "CfnPublicRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "repositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.Object", + }, + "usage": "public java.lang.Object getRepositoryCatalogData();", + }, + Object { + "default": undefined, + "displayName": "repositoryName", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps.property.repositoryName", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.String", + }, + "usage": "public java.lang.String getRepositoryName();", + }, + Object { + "default": undefined, + "displayName": "repositoryPolicyText", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "java.lang.Object", + }, + "usage": "public java.lang.Object getRepositoryPolicyText();", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps.property.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "java.util.List<%>", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "software.amazon.awscdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "public java.util.List getTags();", + }, + ], + "usage": "import software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps; + +CfnPublicRepositoryProps.builder() +// .repositoryCatalogData(java.lang.Object) +// .repositoryName(java.lang.String) +// .repositoryPolicyText(java.lang.Object) +// .tags(java.util.List) + .build();", +} +`; + +exports[`java snapshot 2`] = ` +" CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -# Initializer +# Initializer \`\`\`java import software.amazon.awscdk.services.ecr.CfnPublicRepositoryProps; @@ -109,24 +323,24 @@ CfnPublicRepositoryProps.builder() .build(); \`\`\` -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryCatalogData\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositoryname) | \`java.lang.String\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`java.lang.Object\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#softwareamazonawscdkservicesecrcfnpublicrepositorypropspropertytags) | java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | java.lang.String | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | java.lang.Object | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | java.util.List | \`AWS::ECR::PublicRepository.Tags\`. | --- -## \`repositoryCatalogData\`Optional +## \`repositoryCatalogData\`Optional \`\`\`java public java.lang.Object getRepositoryCatalogData(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -134,13 +348,13 @@ public java.lang.Object getRepositoryCatalogData(); --- -## \`repositoryName\`Optional +## \`repositoryName\`Optional \`\`\`java public java.lang.String getRepositoryName(); \`\`\` -- *Type:* \`java.lang.String\` +- *Type:* java.lang.String \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -148,13 +362,13 @@ public java.lang.String getRepositoryName(); --- -## \`repositoryPolicyText\`Optional +## \`repositoryPolicyText\`Optional \`\`\`java public java.lang.Object getRepositoryPolicyText(); \`\`\` -- *Type:* \`java.lang.Object\` +- *Type:* java.lang.Object \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -162,13 +376,13 @@ public java.lang.Object getRepositoryPolicyText(); --- -## \`tags\`Optional +## \`tags\`Optional \`\`\`java public java.util.List getTags(); \`\`\` -- *Type:* java.util.List<[\`software.amazon.awscdk.core.CfnTag\`](#software.amazon.awscdk.core.CfnTag)> +- *Type:* java.util.List \`AWS::ECR::PublicRepository.Tags\`. @@ -179,13 +393,120 @@ public java.util.List getTags(); `; exports[`python snapshot 1`] = ` -" CfnPublicRepositoryProps +Object { + "displayName": "CfnPublicRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "repository_catalog_data", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_catalog_data", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_catalog_data: typing.Any", + }, + Object { + "default": undefined, + "displayName": "repository_name", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_name", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "str", + }, + "usage": "repository_name: str", + }, + Object { + "default": undefined, + "displayName": "repository_policy_text", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_policy_text", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "typing.Any", + }, + "usage": "repository_policy_text: typing.Any", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "typing.List[%]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "aws_cdk.core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "tags: typing.List[CfnTag]", + }, + ], + "usage": "import aws_cdk.aws_ecr + +aws_cdk.aws_ecr.CfnPublicRepositoryProps( + repository_catalog_data: typing.Any = None, + repository_name: str = None, + repository_policy_text: typing.Any = None, + tags: typing.List[CfnTag] = None +)", +} +`; + +exports[`python snapshot 2`] = ` +" CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -# Initializer +# Initializer \`\`\`python import aws_cdk.aws_ecr @@ -198,24 +519,24 @@ aws_cdk.aws_ecr.CfnPublicRepositoryProps( ) \`\`\` -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repository_catalog_data\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repository_name\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`str\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repository_policy_text\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`typing.Any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] | \`AWS::ECR::PublicRepository.Tags\`. | +| repository_catalog_data | typing.Any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repository_name | str | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repository_policy_text | typing.Any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | typing.List[aws_cdk.core.CfnTag] | \`AWS::ECR::PublicRepository.Tags\`. | --- -## \`repository_catalog_data\`Optional +## \`repository_catalog_data\`Optional \`\`\`python repository_catalog_data: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -223,13 +544,13 @@ repository_catalog_data: typing.Any --- -## \`repository_name\`Optional +## \`repository_name\`Optional \`\`\`python repository_name: str \`\`\` -- *Type:* \`str\` +- *Type:* str \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -237,13 +558,13 @@ repository_name: str --- -## \`repository_policy_text\`Optional +## \`repository_policy_text\`Optional \`\`\`python repository_policy_text: typing.Any \`\`\` -- *Type:* \`typing.Any\` +- *Type:* typing.Any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -251,13 +572,13 @@ repository_policy_text: typing.Any --- -## \`tags\`Optional +## \`tags\`Optional \`\`\`python tags: typing.List[CfnTag] \`\`\` -- *Type:* typing.List[[\`aws_cdk.core.CfnTag\`](#aws_cdk.core.CfnTag)] +- *Type:* typing.List[aws_cdk.core.CfnTag] \`AWS::ECR::PublicRepository.Tags\`. @@ -268,13 +589,115 @@ tags: typing.List[CfnTag] `; exports[`typescript snapshot 1`] = ` -" CfnPublicRepositoryProps +Object { + "displayName": "CfnPublicRepositoryProps", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html", + ], + "summary": "Properties for defining a \`AWS::ECR::PublicRepository\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps", + "properties": Array [ + Object { + "default": undefined, + "displayName": "repositoryCatalogData", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryCatalogData\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData", + "optional": true, + "type": Object { + "formattingPattern": "any", + }, + "usage": "public readonly repositoryCatalogData: any;", + }, + Object { + "default": undefined, + "displayName": "repositoryName", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryName\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName", + "optional": true, + "type": Object { + "formattingPattern": "string", + }, + "usage": "public readonly repositoryName: string;", + }, + Object { + "default": undefined, + "displayName": "repositoryPolicyText", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext", + ], + "summary": "\`AWS::ECR::PublicRepository.RepositoryPolicyText\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText", + "optional": true, + "type": Object { + "formattingPattern": "any", + }, + "usage": "public readonly repositoryPolicyText: any;", + }, + Object { + "default": undefined, + "displayName": "tags", + "docs": Object { + "links": Array [ + "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags", + ], + "summary": "\`AWS::ECR::PublicRepository.Tags\`.", + }, + "fqn": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags", + "optional": true, + "type": Object { + "formattingPattern": "%[]", + "types": Array [ + Object { + "formattingPattern": "%", + "types": Array [ + Object { + "displayName": "CfnTag", + "fqn": "@aws-cdk/core.CfnTag", + "id": "@aws-cdk/core.CfnTag", + "packageName": "@aws-cdk/core", + "packageVersion": "99.99.99", + "submodule": undefined, + }, + ], + }, + ], + }, + "usage": "public readonly tags: CfnTag[];", + }, + ], + "usage": "import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' + +const cfnPublicRepositoryProps: CfnPublicRepositoryProps = { ... }", +} +`; + +exports[`typescript snapshot 2`] = ` +" CfnPublicRepositoryProps Properties for defining a \`AWS::ECR::PublicRepository\`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html) -# Initializer +# Initializer \`\`\`typescript import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' @@ -282,24 +705,24 @@ import { CfnPublicRepositoryProps } from '@aws-cdk/aws-ecr' const cfnPublicRepositoryProps: CfnPublicRepositoryProps = { ... } \`\`\` -# Properties +# Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| [\`repositoryCatalogData\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorycatalogdata) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | -| [\`repositoryName\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositoryname) | \`string\` | \`AWS::ECR::PublicRepository.RepositoryName\`. | -| [\`repositoryPolicyText\`](#awscdkawsecrcfnpublicrepositorypropspropertyrepositorypolicytext) | \`any\` | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | -| [\`tags\`](#awscdkawsecrcfnpublicrepositorypropspropertytags) | [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] | \`AWS::ECR::PublicRepository.Tags\`. | +| repositoryCatalogData | any | \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. | +| repositoryName | string | \`AWS::ECR::PublicRepository.RepositoryName\`. | +| repositoryPolicyText | any | \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. | +| tags | @aws-cdk/core.CfnTag[] | \`AWS::ECR::PublicRepository.Tags\`. | --- -## \`repositoryCatalogData\`Optional +## \`repositoryCatalogData\`Optional \`\`\`typescript public readonly repositoryCatalogData: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryCatalogData\`. @@ -307,13 +730,13 @@ public readonly repositoryCatalogData: any; --- -## \`repositoryName\`Optional +## \`repositoryName\`Optional \`\`\`typescript public readonly repositoryName: string; \`\`\` -- *Type:* \`string\` +- *Type:* string \`AWS::ECR::PublicRepository.RepositoryName\`. @@ -321,13 +744,13 @@ public readonly repositoryName: string; --- -## \`repositoryPolicyText\`Optional +## \`repositoryPolicyText\`Optional \`\`\`typescript public readonly repositoryPolicyText: any; \`\`\` -- *Type:* \`any\` +- *Type:* any \`AWS::ECR::PublicRepository.RepositoryPolicyText\`. @@ -335,13 +758,13 @@ public readonly repositoryPolicyText: any; --- -## \`tags\`Optional +## \`tags\`Optional \`\`\`typescript public readonly tags: CfnTag[]; \`\`\` -- *Type:* [\`@aws-cdk/core.CfnTag\`](#@aws-cdk/core.CfnTag)[] +- *Type:* @aws-cdk/core.CfnTag[] \`AWS::ECR::PublicRepository.Tags\`. diff --git a/test/docgen/view/class.test.ts b/test/docgen/view/class.test.ts index 79405909..27c1e515 100644 --- a/test/docgen/view/class.test.ts +++ b/test/docgen/view/class.test.ts @@ -1,42 +1,28 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; import { Class } from '../../../src/docgen/view/class'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const klass = new Class(transpile, assembly.classes[0], (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const klass = new Class(transpile, assembly.classes[0], (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const klass = new Class(transpile, assembly.classes[0], (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); +const findClass = (): reflect.ClassType => { + if (assembly.classes[0]) { + return assembly.classes[0]; + } + throw new Error('Assembly does not contain a class'); +}; -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const klass = new Class(transpile, assembly.classes[0], (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const klass = new Class(transpile, findClass()).toJson(); + expect(klass).toMatchSnapshot(); + expect(markdown.visitClass(klass).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/documentation.test.ts b/test/docgen/view/documentation.test.ts index 82dde93b..4c55364a 100644 --- a/test/docgen/view/documentation.test.ts +++ b/test/docgen/view/documentation.test.ts @@ -2,7 +2,7 @@ import * as child from 'child_process'; import * as os from 'os'; import * as path from 'path'; import * as fs from 'fs-extra'; -import { Language, Documentation, TranspiledType, UnInstallablePackageError, CorruptedAssemblyError } from '../../../src'; +import { Language, Documentation, UnInstallablePackageError, CorruptedAssemblyError } from '../../../src'; import { extractPackageName } from '../../../src/docgen/view/documentation'; import { Assemblies } from '../assemblies'; @@ -32,16 +32,6 @@ describe('extractPackageName', () => { }); -test('custom link formatter', async () => { - const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); - try { - const markdown = await docs.render({ language: Language.PYTHON, linkFormatter: (t: TranspiledType) => `#custom-${t.fqn}` }); - expect(markdown.render()).toMatchSnapshot(); - } finally { - await docs.cleanup(); - } -}); - test('package installation does not run lifecycle hooks', async () => { const workdir = await fs.mkdtemp(path.join(os.tmpdir(), path.sep)); @@ -63,7 +53,7 @@ test('package installation does not run lifecycle hooks', async () => { // this should succeed because the failure script should be ignored const docs = await Documentation.forPackage(path.join(workdir, 'dist', 'js', `${libraryName}@0.0.0.jsii.tgz`), { name: libraryName }); try { - const markdown = await docs.render(); + const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -74,7 +64,10 @@ describe('python', () => { test('for package', async () => { const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); try { - const markdown = await docs.render({ language: Language.PYTHON }); + const json = await docs.toJson({ language: Language.PYTHON }); + const markdown = await docs.toMarkdown({ language: Language.PYTHON }); + + expect(json.content).toMatchSnapshot(); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -83,14 +76,14 @@ describe('python', () => { test('snapshot - root module', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-ecr', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.PYTHON }); + const markdown = await docs.toMarkdown({ language: Language.PYTHON }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules', async () => { const docs = await Documentation.forAssembly('aws-cdk-lib', Assemblies.AWSCDK_1_106_0); try { - const markdown = await docs.render({ language: Language.PYTHON, submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.PYTHON, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -102,7 +95,7 @@ describe('typescript', () => { test('for package', async () => { const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); try { - const markdown = await docs.render(); + const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -111,13 +104,13 @@ describe('typescript', () => { test('snapshot - single module', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-ecr', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render(); + const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules', async () => { const docs = await Documentation.forAssembly('aws-cdk-lib', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); }); }); @@ -126,7 +119,7 @@ describe('java', () => { test('for package', async () => { const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); try { - const markdown = await docs.render({ language: Language.JAVA }); + const markdown = await docs.toMarkdown({ language: Language.JAVA }); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -135,19 +128,19 @@ describe('java', () => { test('snapshot - root module', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-ecr', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.JAVA }); + const markdown = await docs.toMarkdown({ language: Language.JAVA }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules', async () => { const docs = await Documentation.forAssembly('aws-cdk-lib', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.JAVA, submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.JAVA, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules 2', async () => { const docs = await Documentation.forAssembly('monocdk', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.JAVA, submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.JAVA, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); }); }); @@ -156,7 +149,7 @@ describe('csharp', () => { test('for package', async () => { const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); try { - const markdown = await docs.render({ language: Language.CSHARP }); + const markdown = await docs.toMarkdown({ language: Language.CSHARP }); expect(markdown.render()).toMatchSnapshot(); } finally { await docs.cleanup(); @@ -165,19 +158,19 @@ describe('csharp', () => { test('snapshot - root module', async () => { const docs = await Documentation.forAssembly('@aws-cdk/aws-ecr', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.CSHARP }); + const markdown = await docs.toMarkdown({ language: Language.CSHARP }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules', async () => { const docs = await Documentation.forAssembly('aws-cdk-lib', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.CSHARP, submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.CSHARP, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); }); test('snapshot - submodules 2', async () => { const docs = await Documentation.forAssembly('monocdk', Assemblies.AWSCDK_1_106_0); - const markdown = await docs.render({ language: Language.CSHARP, submodule: 'aws_eks' }); + const markdown = await docs.toMarkdown({ language: Language.CSHARP, submodule: 'aws_eks' }); expect(markdown.render()).toMatchSnapshot(); }); }); @@ -195,11 +188,11 @@ test('throws uninstallable error on missing spec in dependencies', async () => { test('throws corrupt assembly', async () => { const docs = await Documentation.forPackage('@epilot/cdk-constructs@1.0.7'); // this package accepts an unexported HttpApiProps in a constructor - return expect(docs.render()).rejects.toThrowError(CorruptedAssemblyError); + return expect(docs.toMarkdown({ language: Language.TYPESCRIPT })).rejects.toThrowError(CorruptedAssemblyError); }); test('performance on large modules', async () => { const docs = await Documentation.forPackage('@cdktf/provider-aws@4.0.1'); // the assertion here is simply finishing the rendering in time. - await docs.render({ language: Language.PYTHON, submodule: 'wafv2' }); + await docs.toMarkdown({ language: Language.PYTHON, submodule: 'wafv2' }); }); diff --git a/test/docgen/view/enum.test.ts b/test/docgen/view/enum.test.ts index d16a5bf2..1274690c 100644 --- a/test/docgen/view/enum.test.ts +++ b/test/docgen/view/enum.test.ts @@ -1,41 +1,28 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { Language } from '../../../src/docgen/transpile/transpile'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Enum } from '../../../src/docgen/view/enum'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const enu = new Enum(transpile, assembly.enums[0]); - expect(enu.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const enu = new Enum(transpile, assembly.enums[0]); - expect(enu.render().render()).toMatchSnapshot(); - }); -}); +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const enu = new Enum(transpile, assembly.enums[0]); - expect(enu.render().render()).toMatchSnapshot(); - }); -}); +const findEnum = (): reflect.EnumType => { + if (assembly.enums[0]) { + return assembly.enums[0]; + } + throw new Error('Assembly does not contain an emum'); +}; -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const enu = new Enum(transpile, assembly.enums[0]); - expect(enu.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const enu = new Enum(transpile, findEnum()).toJson(); + expect(enu).toMatchSnapshot(); + expect(markdown.visitEnum(enu).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/initializer.test.ts b/test/docgen/view/initializer.test.ts index 0242ef44..4cc2ea72 100644 --- a/test/docgen/view/initializer.test.ts +++ b/test/docgen/view/initializer.test.ts @@ -1,14 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Initializer } from '../../../src/docgen/view/initializer'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; + const findInitializer = (): reflect.Initializer => { for (const klass of assembly.system.classes) { if (klass.initializer) { @@ -18,34 +21,10 @@ const findInitializer = (): reflect.Initializer => { throw new Error('Assembly does not contain an initializer'); }; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const initializer = new Initializer(transpile, findInitializer(), (t: TranspiledType) => `#${t.fqn}`); - expect(initializer.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const initializer = new Initializer(transpile, findInitializer(), (t: TranspiledType) => `#${t.fqn}`); - expect(initializer.render().render()).toMatchSnapshot(); - }); -}); - -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const initializer = new Initializer(transpile, findInitializer(), (t: TranspiledType) => `#${t.fqn}`); - expect(initializer.render().render()).toMatchSnapshot(); - }); -}); - -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const initializer = new Initializer(transpile, findInitializer(), (t: TranspiledType) => `#${t.fqn}`); - expect(initializer.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const init = new Initializer(transpile, findInitializer()).toJson(); + expect(init).toMatchSnapshot(); + expect(markdown.visitInitializer(init).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/instance-method.test.ts b/test/docgen/view/instance-method.test.ts index 6dd23d05..87589ef8 100644 --- a/test/docgen/view/instance-method.test.ts +++ b/test/docgen/view/instance-method.test.ts @@ -1,14 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { Language } from '../../../src/docgen/transpile/transpile'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { InstanceMethod } from '../../../src/docgen/view/instance-method'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; + const findInstanceMethod = (): reflect.Method => { for (const klass of assembly.system.classes) { for (const method of klass.ownMethods) { @@ -20,34 +23,10 @@ const findInstanceMethod = (): reflect.Method => { throw new Error('Assembly does not contain an instance method'); }; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const instanceMethod = new InstanceMethod(transpile, findInstanceMethod(), (t: TranspiledType) => `#${t.fqn}`); - expect(instanceMethod.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const instanceMethod = new InstanceMethod(transpile, findInstanceMethod(), (t: TranspiledType) => `#${t.fqn}`); - expect(instanceMethod.render().render()).toMatchSnapshot(); - }); -}); - -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const instanceMethod = new InstanceMethod(transpile, findInstanceMethod(), (t: TranspiledType) => `#${t.fqn}`); - expect(instanceMethod.render().render()).toMatchSnapshot(); - }); -}); - -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const instanceMethod = new InstanceMethod(transpile, findInstanceMethod(), (t: TranspiledType) => `#${t.fqn}`); - expect(instanceMethod.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const method = new InstanceMethod(transpile, findInstanceMethod()).toJson(); + expect(method).toMatchSnapshot(); + expect(markdown.visitInstanceMethod(method).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/interface.test.ts b/test/docgen/view/interface.test.ts index d6fcf4b6..b9a16700 100644 --- a/test/docgen/view/interface.test.ts +++ b/test/docgen/view/interface.test.ts @@ -1,15 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { Language } from '../../../src/docgen/transpile/transpile'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Interface } from '../../../src/docgen/view/interface'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; -const findInterface = () => { +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; + +const findInterface = (): reflect.InterfaceType => { for (const iface of assembly.interfaces) { if (!iface.datatype) { return iface; @@ -18,34 +21,10 @@ const findInterface = () => { throw new Error('Assembly does not contain an interface'); }; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const klass = new Interface(transpile, findInterface(), (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const klass = new Interface(transpile, findInterface(), (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); - -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const klass = new Interface(transpile, findInterface(), (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); -}); - -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const klass = new Interface(transpile, findInterface(), (t: TranspiledType) => `#${t.fqn}`); - expect(klass.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const iface = new Interface(transpile, findInterface()).toJson(); + expect(iface).toMatchSnapshot(); + expect(markdown.visitInterface(iface).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/markdown.test.ts b/test/docgen/view/markdown.test.ts new file mode 100644 index 00000000..1585c358 --- /dev/null +++ b/test/docgen/view/markdown.test.ts @@ -0,0 +1,56 @@ +import { Documentation, Language } from '../../../src'; +import { JsiiEntity } from '../../../src/docgen/schema'; + +jest.setTimeout(60 * 1000); + +test('custom link formatter', async () => { + const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); + try { + const markdown = await docs.toMarkdown({ + language: Language.PYTHON, + linkFormatter: (type: JsiiEntity) => `${type.displayName}`, + }); + expect(markdown.render()).toMatchSnapshot(); + } finally { + await docs.cleanup(); + } +}); + +test('custom anchor formatter', async () => { + const docs = await Documentation.forPackage('@aws-cdk/aws-ecr@1.106.0'); + try { + const markdown = await docs.toMarkdown({ + language: Language.PYTHON, + anchorFormatter: (type: JsiiEntity) => getAssemblyRelativeName(type), + linkFormatter: (type: JsiiEntity) => { + const name = getAssemblyRelativeName(type); // BucketProps.parameter.accessControl + const submoduleParam = type.submodule ? `&submodule=${type.submodule}` : ''; + return `${type.displayName}`; + }, + }); + expect(markdown.render()).toMatchSnapshot(); + } finally { + await docs.cleanup(); + } +}); + +/** + * Converts a type's id to an assembly-relative version, e.g.: + * `aws-cdk-lib.aws_s3.Bucket.parameter.accessControl` => `Bucket.parameter.accessControl` + */ +function getAssemblyRelativeName(type: JsiiEntity): string { + const parts = type.id.split('.'); + if (type.packageName) { + if (parts[0] !== type.packageName) { + throw new Error(`Expected first part of "${type.id}" to be equal to ${type.packageName}.`); + } + parts.shift(); + if (type.submodule) { + if (parts[0] !== type.submodule) { + throw new Error(`Expected second part of "${type.id}" to be equal to ${type.packageName}.`); + } + parts.shift(); + } + } + return parts.join('.'); +}; diff --git a/test/docgen/view/parameter.test.ts b/test/docgen/view/parameter.test.ts index 69cb7598..558dcdea 100644 --- a/test/docgen/view/parameter.test.ts +++ b/test/docgen/view/parameter.test.ts @@ -1,14 +1,18 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Parameter } from '../../../src/docgen/view/parameter'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; + const findParameter = (): reflect.Parameter => { for (const klass of assembly.system.classes) { for (const method of klass.ownMethods) { @@ -20,44 +24,21 @@ const findParameter = (): reflect.Parameter => { throw new Error('Assembly does not contain a parameter'); }; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const parameter = new Parameter(transpile, findParameter(), (t: TranspiledType) => `#${t.fqn}`); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const parameter = new Parameter(transpile, findParameter(), (t: TranspiledType) => `#${t.fqn}`); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); - -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const parameter = new Parameter(transpile, findParameter(), (t: TranspiledType) => `#${t.fqn}`); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); - -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const parameter = new Parameter(transpile, findParameter(), (t: TranspiledType) => `#${t.fqn}`); - expect(parameter.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const param = new Parameter(transpile, findParameter()).toJson(); + expect(param).toMatchSnapshot(); + expect(markdown.visitParameter(param).render()).toMatchSnapshot(); }); -describe('newlines in "defaults" are removed', () => { +test('newlines in "defaults" are removed', () => { const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const reflectParameter = findParameter(); - reflectParameter.spec.docs = { default: 'default option\nwith a newline' }; - const docgenParameter = new Parameter(transpile, findParameter(), (t: TranspiledType) => `#${t.fqn}`); - expect(docgenParameter.render().render()).toMatchSnapshot(); - }); + const reflectParameter = findParameter(); + reflectParameter.spec.docs = { default: 'default option\nwith a newline' }; + const docgenParameter = new Parameter(transpile, reflectParameter).toJson(); + const renderer = new MarkdownRenderer({ language: Language.TYPESCRIPT, ...metadata }); + const markdown = renderer.visitParameter(docgenParameter).render(); + expect(markdown).toMatchSnapshot(); + expect(markdown).toContain('default option with a newline'); }); diff --git a/test/docgen/view/property.test.ts b/test/docgen/view/property.test.ts index d611e7aa..c46f1df7 100644 --- a/test/docgen/view/property.test.ts +++ b/test/docgen/view/property.test.ts @@ -1,58 +1,30 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Property } from '../../../src/docgen/view/property'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const parameter = new Property( - transpile, - assembly.system.interfaces[0].allProperties[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const parameter = new Property( - transpile, - assembly.system.interfaces[0].allProperties[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const parameter = new Property( - transpile, - assembly.system.interfaces[0].allProperties[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(parameter.render().render()).toMatchSnapshot(); - }); -}); +const findProperty = (): reflect.Property => { + for (const iface of assembly.system.interfaces) { + if (iface.allProperties.length > 0) { + return iface.allProperties[0]; + } + } + throw new Error('Assembly does not contain a property'); +}; -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const parameter = new Property( - transpile, - assembly.system.interfaces[0].allProperties[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(parameter.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const prop = new Property(transpile, findProperty()).toJson(); + expect(prop).toMatchSnapshot(); + expect(markdown.visitProperty(prop).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/static-function.test.ts b/test/docgen/view/static-function.test.ts index 973a21e1..09aa0762 100644 --- a/test/docgen/view/static-function.test.ts +++ b/test/docgen/view/static-function.test.ts @@ -1,14 +1,17 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { StaticFunction } from '../../../src/docgen/view/static-function'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; + const findStaticFunction = (): reflect.Method => { for (const klass of assembly.system.classes) { for (const method of klass.ownMethods) { @@ -20,34 +23,10 @@ const findStaticFunction = (): reflect.Method => { throw new Error('Assembly does not contain a static function'); }; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const staticFunction = new StaticFunction(transpile, findStaticFunction(), (t: TranspiledType) => `#${t.fqn}`); - expect(staticFunction.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const staticFunction = new StaticFunction(transpile, findStaticFunction(), (t: TranspiledType) => `#${t.fqn}`); - expect(staticFunction.render().render()).toMatchSnapshot(); - }); -}); - -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const staticFunction = new StaticFunction(transpile, findStaticFunction(), (t: TranspiledType) => `#${t.fqn}`); - expect(staticFunction.render().render()).toMatchSnapshot(); - }); -}); - -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const staticFunction = new StaticFunction(transpile, findStaticFunction(), (t: TranspiledType) => `#${t.fqn}`); - expect(staticFunction.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const func = new StaticFunction(transpile, findStaticFunction()).toJson(); + expect(func).toMatchSnapshot(); + expect(markdown.visitStaticFunction(func).render()).toMatchSnapshot(); }); diff --git a/test/docgen/view/struct.test.ts b/test/docgen/view/struct.test.ts index 0ae4b3a7..ae33bee7 100644 --- a/test/docgen/view/struct.test.ts +++ b/test/docgen/view/struct.test.ts @@ -1,58 +1,30 @@ import * as reflect from 'jsii-reflect'; -import { CSharpTranspile } from '../../../src/docgen/transpile/csharp'; -import { JavaTranspile } from '../../../src/docgen/transpile/java'; -import { PythonTranspile } from '../../../src/docgen/transpile/python'; -import { TranspiledType } from '../../../src/docgen/transpile/transpile'; -import { TypeScriptTranspile } from '../../../src/docgen/transpile/typescript'; +import { Language } from '../../../src'; +import { MarkdownRenderer } from '../../../src/docgen/render/markdown-render'; +import { LANGUAGE_SPECIFIC } from '../../../src/docgen/view/documentation'; import { Struct } from '../../../src/docgen/view/struct'; import { Assemblies } from '../assemblies'; const assembly: reflect.Assembly = Assemblies.instance.withoutSubmodules; -describe('python', () => { - const transpile = new PythonTranspile(); - test('snapshot', () => { - const struct = new Struct( - transpile, - assembly.system.interfaces.filter((i) => i.datatype)[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(struct.render().render()).toMatchSnapshot(); - }); -}); - -describe('typescript', () => { - const transpile = new TypeScriptTranspile(); - test('snapshot', () => { - const struct = new Struct( - transpile, - assembly.system.interfaces.filter((i) => i.datatype)[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(struct.render().render()).toMatchSnapshot(); - }); -}); +const metadata = { + packageName: assembly.name, + packageVersion: assembly.version, +}; -describe('java', () => { - const transpile = new JavaTranspile(); - test('snapshot', () => { - const struct = new Struct( - transpile, - assembly.system.interfaces.filter((i) => i.datatype)[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(struct.render().render()).toMatchSnapshot(); - }); -}); +const findStruct = (): reflect.InterfaceType => { + for (const iface of assembly.interfaces) { + if (iface.datatype) { + return iface; + } + } + throw new Error('Assembly does not contain a struct'); +}; -describe('csharp', () => { - const transpile = new CSharpTranspile(); - test('snapshot', () => { - const struct = new Struct( - transpile, - assembly.system.interfaces.filter((i) => i.datatype)[0], - (t: TranspiledType) => `#${t.fqn}`, - ); - expect(struct.render().render()).toMatchSnapshot(); - }); +test.each(Language.values())('%s snapshot', (language) => { + const { transpile } = LANGUAGE_SPECIFIC[language.toString()]; + const markdown = new MarkdownRenderer({ language, ...metadata }); + const struct = new Struct(transpile, findStruct()).toJson(); + expect(struct).toMatchSnapshot(); + expect(markdown.visitStruct(struct).render()).toMatchSnapshot(); });