Class ActivateTypeRequest

    • Method Detail

      • type

        public final ThirdPartyType type()

        The extension type.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The extension type.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        See Also:
        ThirdPartyType
      • typeAsString

        public final String typeAsString()

        The extension type.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The extension type.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        See Also:
        ThirdPartyType
      • publicTypeArn

        public final String publicTypeArn()

        The Amazon Resource Name (ARN) of the public extension.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        Returns:
        The Amazon Resource Name (ARN) of the public extension.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

      • publisherId

        public final String publisherId()

        The ID of the extension publisher.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        Returns:
        The ID of the extension publisher.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

      • typeName

        public final String typeName()

        The name of the extension.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

        Returns:
        The name of the extension.

        Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

      • typeNameAlias

        public final String typeNameAlias()

        An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

        An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

        Returns:
        An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

        An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

      • autoUpdate

        public final Boolean autoUpdate()

        Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

        The default is true.

        Returns:
        Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

        The default is true.

      • loggingConfig

        public final LoggingConfig loggingConfig()

        Contains logging configuration information for an extension.

        Returns:
        Contains logging configuration information for an extension.
      • executionRoleArn

        public final String executionRoleArn()

        The name of the IAM execution role to use to activate the extension.

        Returns:
        The name of the IAM execution role to use to activate the extension.
      • versionBump

        public final VersionBump versionBump()

        Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

        • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

        • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

        If the service returns an enum value that is not available in the current SDK version, versionBump will return VersionBump.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionBumpAsString().

        Returns:
        Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

        • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

        • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

        See Also:
        VersionBump
      • versionBumpAsString

        public final String versionBumpAsString()

        Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

        • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

        • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

        If the service returns an enum value that is not available in the current SDK version, versionBump will return VersionBump.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionBumpAsString().

        Returns:
        Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

        • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

        • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

        See Also:
        VersionBump
      • majorVersion

        public final Long majorVersion()

        The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

        You can specify MajorVersion or VersionBump, but not both.

        Returns:
        The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

        You can specify MajorVersion or VersionBump, but not both.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object