Interface TypeSummary.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<TypeSummary.Builder,TypeSummary>
,SdkBuilder<TypeSummary.Builder,TypeSummary>
,SdkPojo
- Enclosing class:
- TypeSummary
public static interface TypeSummary.Builder extends SdkPojo, CopyableBuilder<TypeSummary.Builder,TypeSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TypeSummary.Builder
defaultVersionId(String defaultVersionId)
The ID of the default version of the extension.TypeSummary.Builder
description(String description)
The description of the extension.TypeSummary.Builder
isActivated(Boolean isActivated)
Whether the extension is activated for this account and Region.TypeSummary.Builder
lastUpdated(Instant lastUpdated)
When the specified extension version was registered.TypeSummary.Builder
latestPublicVersion(String latestPublicVersion)
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available.TypeSummary.Builder
originalTypeName(String originalTypeName)
For public extensions that have been activated for this account and Region, the type name of the public extension.TypeSummary.Builder
publicVersionNumber(String publicVersionNumber)
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.TypeSummary.Builder
publisherId(String publisherId)
The ID of the extension publisher, if the extension is published by a third party.TypeSummary.Builder
publisherIdentity(String publisherIdentity)
The service used to verify the publisher identity.TypeSummary.Builder
publisherIdentity(IdentityProvider publisherIdentity)
The service used to verify the publisher identity.TypeSummary.Builder
publisherName(String publisherName)
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.TypeSummary.Builder
type(String type)
The kind of extension.TypeSummary.Builder
type(RegistryType type)
The kind of extension.TypeSummary.Builder
typeArn(String typeArn)
The Amazon Resource Name (ARN) of the extension.TypeSummary.Builder
typeName(String typeName)
The name of the extension.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
type
TypeSummary.Builder type(String type)
The kind of extension.
- Parameters:
type
- The kind of extension.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RegistryType
,RegistryType
-
type
TypeSummary.Builder type(RegistryType type)
The kind of extension.
- Parameters:
type
- The kind of extension.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RegistryType
,RegistryType
-
typeName
TypeSummary.Builder typeName(String typeName)
The name of the extension.
If you specified a
TypeNameAlias
when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.- Parameters:
typeName
- The name of the extension.If you specified a
TypeNameAlias
when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultVersionId
TypeSummary.Builder defaultVersionId(String defaultVersionId)
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns
null
. For more information, see RegisterType.To set the default version of an extension, use SetTypeDefaultVersion.
- Parameters:
defaultVersionId
- The ID of the default version of the extension. The default version is used when the extension version isn't specified.This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns
null
. For more information, see RegisterType.To set the default version of an extension, use SetTypeDefaultVersion.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
typeArn
TypeSummary.Builder typeArn(String typeArn)
The Amazon Resource Name (ARN) of the extension.
- Parameters:
typeArn
- The Amazon Resource Name (ARN) of the extension.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdated
TypeSummary.Builder lastUpdated(Instant lastUpdated)
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns
null
.- Parameters:
lastUpdated
- When the specified extension version was registered. This applies only to:-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns
null
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
description
TypeSummary.Builder description(String description)
The description of the extension.
- Parameters:
description
- The description of the extension.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publisherId
TypeSummary.Builder publisherId(String publisherId)
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
- Parameters:
publisherId
- The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originalTypeName
TypeSummary.Builder originalTypeName(String originalTypeName)
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a
TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.- Parameters:
originalTypeName
- For public extensions that have been activated for this account and Region, the type name of the public extension.If you specified a
TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicVersionNumber
TypeSummary.Builder publicVersionNumber(String publicVersionNumber)
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified
AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.- Parameters:
publicVersionNumber
- For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.How you specified
AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestPublicVersion
TypeSummary.Builder latestPublicVersion(String latestPublicVersion)
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns
null
.How you specified
AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.- Parameters:
latestPublicVersion
- For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returnsnull
.How you specified
AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publisherIdentity
TypeSummary.Builder publisherIdentity(String publisherIdentity)
The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
- Parameters:
publisherIdentity
- The service used to verify the publisher identity.For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IdentityProvider
,IdentityProvider
-
publisherIdentity
TypeSummary.Builder publisherIdentity(IdentityProvider publisherIdentity)
The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
- Parameters:
publisherIdentity
- The service used to verify the publisher identity.For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IdentityProvider
,IdentityProvider
-
publisherName
TypeSummary.Builder publisherName(String publisherName)
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
- Parameters:
publisherName
- The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isActivated
TypeSummary.Builder isActivated(Boolean isActivated)
Whether the extension is activated for this account and Region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
- Parameters:
isActivated
- Whether the extension is activated for this account and Region.This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-